Merge pull request #79 from fe/feature/register-npm

Feature/register npm

Author: 홍유정/FE개발랩/NE

.eslintrc

@@ -0,0 +1,14 @@
+module.exports = {
+    "extends": "tui",
+    "env": {
+        "browser": true,
+        "amd": true,
+        "node": true,
+        "jasmine": true,
+        "jquery": true
+    },
+    "globals": {
+        "tui": true,
+        "loadFixtures": true
+    }
+};

.eslintrc.js

@@ -7,27 +7,19 @@ pids
 *.pid
 *.seed
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
+# Compiled files
+dist
 
 # Dependency directory
-# Deployed apps should consider commenting this line out:
-# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
 
 # Bower Components
 bower_components
 lib
 
+#JSDOC
+doc
+
 # IDEA
 .idea
 *.iml
@@ -39,18 +31,18 @@ Desktop.ini
 # MAC
 .DS_Store
 
-# SVN
-.svn
-bin
 # eclipse
 .project
 .metadata
 
-# etc
-temp
-tmp
-doc
+#report / screenshots
 report
-*.swp
-karma.local.conf.js
-*.vim
+screenshots
+
+# Atom
+tags
+.ctags
+.tern-project
+
+# etc
+.agignore

.gitignore

@@ -1,5 +1,4 @@
-Toast UI CodeSnippet
-======================
+# Toast UI CodeSnippet
 
 `tui-code-snippet` is group of utility methods to make ease with developing javascript applications.
 
@@ -50,29 +49,61 @@ It includes several features like `class simulation`, `browser detecting`, `type
 * defineModule.js
  * Support utils to define modules
 
-## How to use CodeSnippet
-* Using CodeSnippet build file
- * Download `tui-code-snippet.js` or `tui-code-snippet.min.js` from [[master branch]](https://github.com/nhnent/tui.code-snippet)
- * It's better that you do not change the file name.
-* Using the copy only the necesary parts
- * Check dependency before copy the codes
- * Use build file as you can
-
 ## Documentation
-* API: https://nhnent.github.io/tui.code-snippet/latest/
-* Tutorial: https://github.com/nhnent/fe.javascript/wiki/FE-CodeSnippet
+* API: [https://nhnent.github.io/tui.code-snippet/latest/](https://nhnent.github.io/tui.code-snippet/latest/);
+* Tutorial: [https://github.com/nhnent/fe.javascript/wiki/Toast-UI-CodeSnippet](https://github.com/nhnent/fe.javascript/wiki/Toast-UI-CodeSnippet)
 
 ## Tested Browsers
 * browser:
-   * IE8+
+   * IE8 ~ IE11
+   * Edge
    * Chrome
    * Firefox
+   * Safari
+
+## Usage
+### Use `npm`
+
+Install the latest version using `npm` command:
+
+```
+$ npm install tui-code-snippet --save
+```
+
+or want to install the each version:
+
+```
+$ npm install tui-code-snippet@<version> --save
+```
+
+To access as module format in your code:
+
+```javascript
+var util = require('tui-code-snippet');
+```
+
+### Use `bower`
+Install the latest version using `bower` command:
+
+```
+$ bower install tui-code-snippet
+```
+
+or want to install the each version:
+
+```
+$ bower install tui-code-snippet#<tag>
+```
+
+To access as namespace format in your code:
+
+```javascript
+var util = tui.util;
+```
+
+### Download
+* [Download bundle files from `dist` folder](https://github.com/nhnent/tui.code-snippet/tree/production/dist)
+* [Download all sources for each version](https://github.com/nhnent/tui.code-snippet/releases)
 
-## Download/Install
-* bower:
-   * Latest: `bower install tui-code-snippet`
-   * Each Version: `bower install tui-code-snippet[#tag]`
-* npm:
-   * Latest: `npm install tui-code-snippet`
-   * Each Version: `npm install tui-code-snippet[@tag]`
-* Download: https://github.com/nhnent/tui.code-snippet
+## License
+[MIT LICENSE](https://github.com/nhnent/tui.code-snippet/blob/master/LICENSE)

README.md

@@ -1,22 +1,20 @@
 {
   "name": "tui-code-snippet",
   "authors": [
-    "NHN Ent. FE dev Lab(dl_javascript@nhnent.com)"
+     "NHNent. FE Development Lab <dl_javascript@nhnent.com>"
   ],
-  "license": "MIT",
   "main": "dist/tui-code-snippet.js",
+  "license": "MIT",
   "ignore": [
     "**/.*",
     ".*",
-    "src",
     "node_modules",
     "bower_components",
+    "src",
     "test",
-    "bower.json",
+    "jsdoc.conf.json",
+    "karma.conf.js",
     "webpack.config.js",
-    "jsdoc.conf.json"
-  ],
-  "devDependencies": {
-    "jquery": "~1.8.3"
-  }
+    "package.json"
+  ]
 }