Skip to content

Commit 7fb8140

Browse files
author
Victor Bjelkholm
committed
Version 1.0.0 and readme
1 parent 7160e9c commit 7fb8140

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "trymodule",
3-
"version": "0.0.1",
3+
"version": "1.0.0",
44
"description": "",
55
"main": "index.js",
66
"scripts": {

readme.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## trymodule
2+
3+
A simple cli tool for trying out different nodejs modules.
4+
5+
## Installation
6+
7+
`npm install -g trymodule`
8+
9+
## Usage
10+
11+
`trymodule colors` < downloads the module colors if needed, and starts a nodejs REPL with colors loaded in the current scope, ready for you to use.
12+
13+
## Remove installed packages
14+
15+
trymodule uses `$HOME/.trymodule` for storing nodejs modules. Remove this folder to "clear" the cache
16+
17+
## Support / Help
18+
19+
If you have any questions, open a Github issue here:
20+
[github.com/VictorBjelkholm/trymodule/issues/new](https://github.com/VictorBjelkholm/trymodule/issues/new)
21+
22+
or feel free to contact me on Twitter here:
23+
[@VictorBjelkholm](https://twitter.com/VictorBjelkholm)
24+
25+
## License
26+
27+
The MIT License (MIT)
28+
29+
Copyright (c) 2016 Victor Bjelkholm
30+
31+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
32+
33+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
34+
35+
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.

0 commit comments

Comments
 (0)