Skip to content

Commit

Permalink
Remove grunt-readme since it does not work anymore
Browse files Browse the repository at this point in the history
  • Loading branch information
ai committed Jul 8, 2018
1 parent 1afbad6 commit efeb958
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 730 deletions.
17 changes: 6 additions & 11 deletions README.md
Expand Up @@ -126,9 +126,9 @@ users.insert({

__Default:__ `'0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_'`

__Returns__ new alphabet as a `string`
__Returns__ new alphabet as a `string`

__Recommendation:__ If you don't like _ or -, you can to set new characters to use.
__Recommendation:__ If you don't like _ or -, you can to set new characters to use.

__Optional__

Expand Down Expand Up @@ -181,9 +181,9 @@ __Recommendation:__ You typically won't want to change this.

__Optional__

If you are running multiple server processes then you should make sure every one has a unique `worker` id. Should be an integer between 0 and 16.
If you do not do this there is very little chance of two servers generating the same id, but it is theoretically possible
if both are generated in the exact same second and are generating the same number of ids that second and a half-dozen random numbers are all exactly the same.
If you are running multiple server processes then you should make sure every one has a unique `worker` id. Should be an integer between 0 and 16.
If you do not do this there is very little chance of two servers generating the same id, but it is theoretically possible
if both are generated in the exact same second and are generating the same number of ids that second and a half-dozen random numbers are all exactly the same.

__Example__

Expand All @@ -203,7 +203,7 @@ __Optional__

Choose a unique value that will seed the random number generator so users won't be able to figure out the pattern of the unique ids. Call it just once in your application before using `shortId` and always use the same value in your application.

Most developers won't need to use this, it's mainly for testing ShortId.
Most developers won't need to use this, it's mainly for testing ShortId.

If you are worried about users somehow decrypting the id then use it as a secret value for increased encryption.

Expand Down Expand Up @@ -248,8 +248,3 @@ Copyright (c) 2016 Dylan Greene, contributors.
Released under the [MIT license](https://tldrlegal.com/license/mit-license).

Screenshots are [CC BY-SA](http://creativecommons.org/licenses/by-sa/4.0/) (Attribution-ShareAlike).

***
_Generated using [grunt-readme](https://github.com/assemble/grunt-readme) with [grunt-templates-dylang](https://github.com/dylang/grunt-templates-dylang) on Sunday, April 3, 2016._
_To make changes to this document look in `/templates/readme/`

6 changes: 2 additions & 4 deletions package.json
Expand Up @@ -5,8 +5,7 @@
"main": "index.js",
"scripts": {
"build": "grunt build",
"test": "grunt test",
"readme": "grunt repos readme"
"test": "grunt test"
},
"keywords": [
"short",
Expand Down Expand Up @@ -36,16 +35,15 @@
"chai": "^3.3.0",
"envify": "^3.4.0",
"grunt": "^0.4.5",
"grunt-cli": "^0.1.13",
"grunt-browserify": "^3.6.0",
"grunt-cli": "^0.1.13",
"grunt-contrib-concat": "^0.5.1",
"grunt-contrib-jshint": "^0.11.3",
"grunt-contrib-uglify": "^0.9.2",
"grunt-mocha-test": "^0.12.7",
"grunt-notify": "^0.4.1",
"grunt-open": "^0.2.3",
"grunt-release": "^0.13.0",
"grunt-templates-dylang": "^1.0.10",
"load-grunt-tasks": "^3.3.0",
"mocha": "^2.3.3",
"time-grunt": "^1.2.1"
Expand Down
112 changes: 0 additions & 112 deletions templates/readme/api.md

This file was deleted.

12 changes: 0 additions & 12 deletions templates/readme/browser.md

This file was deleted.

40 changes: 0 additions & 40 deletions templates/readme/examples.md

This file was deleted.

11 changes: 0 additions & 11 deletions templates/readme/intro.md

This file was deleted.

16 changes: 0 additions & 16 deletions templates/readme/usage.md

This file was deleted.

10 changes: 0 additions & 10 deletions templates/shortid.md

This file was deleted.

0 comments on commit efeb958

Please sign in to comment.