Skip to content

Commit

Permalink
Update README.md.
Browse files Browse the repository at this point in the history
Remove unnecessary nodejs version for travis-ci.
Remove "lib" directory.
  • Loading branch information
cyrilschumacher committed May 22, 2016
1 parent 5154d1a commit 21db7e9
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 195 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ language: node_js
node_js:
- "5"
- "5.1"
- "4"
- "4.2"
- "4.1"
- "4.0"
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# json-property-filter

[![MIT License][license-image]][license-url]
[![npm version][npmjs-image]][npmjs-url]
[![Build Status][travis-image]][travis-url]
[![typescript-standard-style][standard-image]][standard-url]
[![david-dm Status][david-image]][david-url]
Expand All @@ -18,12 +19,20 @@ $ npm install json-property-filter

To using [TypeScript](https://www.typescriptlang.org/) or JavaScript (ES6 support) language:
```javascript
import {JsonPropertyFilter} from "../src/jsonPropertyFilter";
import {JsonPropertyFilter} from "json-property-filter";

var filter = new JsonPropertyFilter("**");
filter.apply({ key: "value" });
```

If you use JavaScript (ES5 support) language:
```javascript
var JsonPropertyFilter = require("JsonPropertyFilter");

var filter = new JsonPropertyFilter.JsonPropertyFilter("**");
filter.apply({ key: "value" });
```

### `include` filters

- all properties: `**`
Expand Down Expand Up @@ -91,6 +100,8 @@ $ npm test
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[npmjs-image]:https://badge.fury.io/js/json-property-filter.svg
[npmjs-url]:https://www.npmjs.com/package/json-property-filter
[david-dev-dependencies-image]: https://david-dm.org/cyrilschumacher/json-property-filter/dev-status.svg
[david-dev-dependencies-url]: https://david-dm.org/cyrilschumacher/json-property-filter#info=devDependencies
[david-image]: https://david-dm.org/cyrilschumacher/json-property-filter.svg
Expand Down
14 changes: 0 additions & 14 deletions lib/jsonIncludePropertyFilter.d.ts

This file was deleted.

59 changes: 0 additions & 59 deletions lib/jsonIncludePropertyFilter.js

This file was deleted.

9 changes: 0 additions & 9 deletions lib/jsonPropertyFilter.d.ts

This file was deleted.

41 changes: 0 additions & 41 deletions lib/jsonPropertyFilter.js

This file was deleted.

4 changes: 0 additions & 4 deletions lib/jsonSerializer.d.ts

This file was deleted.

66 changes: 0 additions & 66 deletions lib/jsonSerializer.js

This file was deleted.

0 comments on commit 21db7e9

Please sign in to comment.