Merge pull request #18 from knowledgecode/develop-1.2.0

Author: knowledgecode

.circleci/config.yml

@@ -1,36 +1,15 @@
-version: 2
+version: 2.1
+
 jobs:
-  build:
-    docker:
-      - image: circleci/node:latest
-    steps:
-      - checkout
-      - run:
-          name: Update npm
-          command: 'sudo npm install -g npm@latest'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: Install npm wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - node_modules
-  test:
+  build_and_test:
     docker:
-      - image: circleci/node:latest
+      - image: cimg/node:current
     steps:
       - checkout
-      - run:
-          name: Test
-          command: npm test
+      - run: npm install
+      - run: npm test
 
 workflows:
-  version: 2
   build_and_test:
     jobs:
-      - build
-      - test:
-          requires:
-            - build
+      - build_and_test

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
+dist
 node_modules

README.md

@@ -11,60 +11,51 @@
 
 ## Installation
 
-Node.js:
+via npm:
 
 ```shell
-npm install jquery-param --save
-```
-
-the browser:
-
-```html
-<script src="/path/to/jquery-param.min.js"></script>
+npm i jquery-param
 ```
 
 ## Usage
 
-CommonJS:
-
 ```javascript
-const param = require('jquery-param');
+import param from 'jquery-param';
 
 const obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' };
 const str = param(obj);
 // => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d"
 ```
 
-TypeScript:
+CommonJS:
 
 ```javascript
-import param from 'jquery-param';
+const param = require('jquery-param');
 
 const obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' };
 const str = param(obj);
 // => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d"
 ```
 
-*You will need to add `"esModuleInterop": true` to the `"compilerOptions"` field in `tsconfig.json`.*
-
-ES Modules:
+ES Modules (Browser):
 
 ```html
 <script type="module">
-import param from './esm/jquery-param.es.js';
+import param from '/path/to/jquery-param.js';
 
 const obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' };
 const str = param(obj);
 // => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d"
 </script>
 ```
 
-Older browser:
+Traditional (Browser):
 
 ```html
+<script src="/path/to/jquery-param.js">
 <script>
 var obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' };
-var str = window.param(obj);    // global object
+var str = window.param(obj);
 // => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d"
 </script>
 ```