Finishing documentation README file and create a npm package file

dioney · Aug 6, 2016 · bb4eb8d · bb4eb8d
1 parent d15d31c
commit bb4eb8d
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,26 +1,53 @@
-# AdminPure - Alpha
+# AdminPure
 
-This is admin panel based in PureCSS.
+This is a admin panel based in PureCSS. Create your panel system independent language programming. Elegant and modern theme for your application. The main motivation to offer clean and beautful interface, free and open source use.
 
 # Installation
 
-Clone this repository
+Clone this repository or [Download Zip File](https://github.com/dioney/adminpure/archive/master.zip):
 
 ```
 git clone https://github.com/dioney/adminpure
 ```
-Install bower dependencies
 
+Install NPM packages:
 ```
-bower install
+npm install --save
 ```
+Option 1: Installation dependencies with bower (PureCSS, FontAwesome and ChartJS):
 
-## Using Packages
+```
+bower install --save
+```
+
+Option 2: Instalation manual method
+
+Insert between <head></head> code:
+
+```
+<!-- Insert PureCSS -->
+<link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/pure-min.css">
+
+<!-- Insert FontAwesome -->
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css">
+
+<!-- Insert ChartJS -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.2.1/Chart.min.js"></script>
+
+<!-- Insert Style Base AdminPure -->
+<link rel="stylesheet" href="assets/style.css">
+```
+
+Insert in end document before tag </body>
+```
+<!-- Insert JavaScript manipulation, current use responsive utilities -->
+<script src="assets/functions.js"></script>
+```
+
+It`s Works! Customize your theme in assets/style.css file.
+
+## Using Packages and Read Documentation
 
 - [PureCSS](http://purecss.io/)
 - [Font Awesome](http://fontawesome.io/)
 - [ChartJS](http://www.chartjs.org/)
-
-# Working in progress
-
-This is a admin panel based in PureCSS. Create your system independent language programming. Elegant and modern theme for your application.
diff --git a/assets/ui.js → assets/functions.js b/assets/ui.js → assets/functions.js
diff --git a/index.html b/index.html
@@ -129,7 +129,7 @@ <h3 class="header-title">Posts</h3>
 		</div>
 	</div>
 
-<script src="assets/ui.js"></script>
+<script src="assets/functions.js"></script>
 </div>
 
 </body>

diff --git a/package.json b/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "adminpure",
+  "version": "1.0.0",
+  "description": "Admin panel based in PureCSS",
+  "main": "index.js",
+  "dependencies": {
+    "chart.js": "^2.2.1"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dioney/adminpure.git"
+  },
+  "keywords": [
+    "purecss",
+    "admin",
+    "panel",
+    "simple"
+  ],
+  "author": "Dioney Vítor",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/dioney/adminpure/issues"
+  },
+  "homepage": "https://github.com/dioney/adminpure#readme"
+}