瀏覽代碼

Merge branch 'master' of github.com:codedgar/Puppertino

Edgar Pérez 7 月之前
父節點
當前提交
bf8ae2031f
共有 4 個文件被更改,包括 59 次插入3 次删除
  1. 28 0
      README.md
  2. 29 0
      package.json
  3. 1 2
      src/js/Puppertino.js
  4. 1 1
      src/js/actions.js

+ 28 - 0
README.md

@@ -35,6 +35,34 @@ If you only need specific components, you can import them individually to reduce
 
 You can also find the full list of individual components and their CDN links on the [Components page](https://codedgar.github.io/Puppertino/examples/).
 
+### NPM
+
+You can install this repository through NPM + GIT:
+```bash
+# Via SSH
+npm i --save git@github.com:codedgar/Puppertino.git#{{BRANCH_NAME}}
+
+# Eg.
+npm i --save git@github.com:codedgar/Puppertino.git#master
+
+# Or Via HTTPS
+npm i --save https://github.com/codedgar/Puppertino.git#BRANCH_NAME
+
+# Eg.
+npm i --save https://github.com/codedgar/Puppertino.git#master
+```
+
+You can change master with the branch of your choosing to install a specific branch. After NPM installation,
+you can simply import the library from `node_modules`
+
+#### In your CSS
+```css
+@import("path/to/node_modules/puppertino/dist/full.css")
+```
+#### In your Javascript
+```js
+require("path/to/node_modules/puppertino/src/js/{{file you need, eg tabs.js}}")
+```
 
 ## Current Components
 

+ 29 - 0
package.json

@@ -0,0 +1,29 @@
+{
+  "name": "puppertino",
+  "version": "1.0.0",
+  "description": "A CSS framework based on Human Guidelines from Apple",
+  "main": "none",
+  "directories": {
+    "doc": "docs"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/codedgar/Puppertino.git"
+  },
+  "keywords": [
+    "css",
+    "framework",
+    "ui",
+    "uikit",
+    "apple"
+  ],
+  "author": "Codedgar",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/codedgar/Puppertino/issues"
+  },
+  "homepage": "https://github.com/codedgar/Puppertino#readme"
+}

+ 1 - 2
src/js/Puppertino.js

@@ -2,7 +2,7 @@ function Puppertino(options, selector){
     return {
         options: options,
         selector: selector,
-        modal: function(selector){
+        modal: function(selector) {
             console.log('AAAAAAAA');
 
             this.init = function(){
@@ -12,7 +12,6 @@ function Puppertino(options, selector){
                 console.log(document.querySelector(selector));
             }
             this.hide = function(selector){
-
                 console.log(document.querySelector(selector));
             }
             this.toggle = function(selector){

+ 1 - 1
src/js/actions.js

@@ -117,4 +117,4 @@ class PuppertinoActionsMan {
   
   // Initialize the PuppertinoActionsMan instance
   const PuppertinoActionsManager = new PuppertinoActionsMan();
-  
+