Skip to content

Commit

Permalink
Documentation and updates for new deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
khalidsalomao committed May 13, 2016
1 parent 281cad8 commit e04cc80
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 14 deletions.
3 changes: 2 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.*
spec
bower*
index.html
node_modules
test*
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ All notable changes to this project will be documented in this file.

[unreleased]: https://github.com/khalidsalomao/simple-query-string/compare/1.2.0...HEAD


### [v1.2.2] - 2016-05-13

- documentation updated
- more tests refactoring


### [v1.2.1] - 2016-05-13

- bug fix when stringify multiple arrays
- some tests refactoring


### [v1.2.0] - 2016-05-12
Expand Down
49 changes: 39 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Fast and simple way to parse and stringify URL query strings.
Utility javascript methods to encode and decode query string parameters with extreme performance and low memory usage.


-----
### Installation

**NPM**
Expand All @@ -17,16 +18,23 @@ $ npm install simple-query-string
**Bower**

```
$ bower i simple-query-string
$ bower install simple-query-string
```


**Download**

* [simplequerystring.js - development](https://github.com/khalidsalomao/simple-query-string/releases/download/1.2.2/simplequerystring.js)

* [simplequerystring.min.js - production](https://github.com/khalidsalomao/simple-query-string/releases/download/1.2.2/simplequerystring.min.js)

**Browser - CDN**
```
<script src="https://cdn.rawgit.com/khalidsalomao/simple-query-string/1.2.0/src/simplequerystring.min.js"></script>
<script src="https://cdn.rawgit.com/khalidsalomao/simple-query-string/1.2.2/src/simplequerystring.min.js"></script>
```


----
### Features

#### Query String Decoding
Expand Down Expand Up @@ -80,7 +88,7 @@ $ bower i simple-query-string
* browser

```
<script src="https://cdn.rawgit.com/khalidsalomao/simple-query-string/1.2.0/src/simplequerystring.js"></script>
<script src="https://cdn.rawgit.com/khalidsalomao/simple-query-string/1.2.2/src/simplequerystring.js"></script>
<script>
var parsed = simpleQueryString.parse("key=val&param=1");
Expand Down Expand Up @@ -130,7 +138,7 @@ $ bower i simple-query-string
* browser

```
<script src="https://cdn.rawgit.com/khalidsalomao/simple-query-string/1.2.0/src/simplequerystring.js"></script>
<script src="https://cdn.rawgit.com/khalidsalomao/simple-query-string/1.2.2/src/simplequerystring.js"></script>
<script>
var str = simpleQueryString.stringify({ param: 1, p2: true, p3: false });
Expand Down Expand Up @@ -168,22 +176,43 @@ var qStr = simpleQueryString.stringify(p);
```


-----
### How to Test


#### Install dependencies
#### Node.js

##### Install dependencies

```
$ npm install mocha -g
```


##### Run tests in node.js

```
$ npm test
```


`npm install bower -g`
#### Browser

`bower update`
##### Install dependencies

```
$ npm install bower -g
$ bower update
```


#### Run tests
##### Run tests in browser

Run the tests by opening `index.html`.
Run the tests by opening `./spec/testpage.html`.


-----
### Additional Information

Project generated by [yeoman generator-test](https://github.com/phillipalexander/generator-test):
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name" : "simple-query-string",
"version" : "1.2.0",
"version" : "1.2.2",
"description": "Fast and simple way to parse and stringify URL query strings",
"dependencies" : {},
"devDependencies" : {
Expand Down
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "simple-query-string",
"version": "1.2.1",
"version": "1.2.2",
"description": "Fast and simple way to parse and stringify URL query strings",
"main": "src/simplequerystring.js",
"scripts": {
Expand Down Expand Up @@ -30,5 +30,9 @@
"bugs": {
"url": "https://github.com/khalidsalomao/simple-query-string/issues"
},
"homepage": "https://github.com/khalidsalomao/simple-query-string#readme"
"homepage": "https://github.com/khalidsalomao/simple-query-string#readme",
"devDependencies" : {
"chai" : "*",
"lodash" : "*"
}
}
File renamed without changes.

0 comments on commit e04cc80

Please sign in to comment.