1 |
|
2 | [![idea](http://i.imgur.com/BGMt0Ne.png)](#)
|
3 |
|
4 | # `$ idea`
|
5 |
|
6 | [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/idea.svg)](https://www.npmjs.com/package/idea) [![Downloads](https://img.shields.io/npm/dt/idea.svg)](https://www.npmjs.com/package/idea)
|
7 |
|
8 | > A lightweight CLI tool and module for keeping ideas in a safe place quick and easy.
|
9 |
|
10 | ## :cloud: Installation
|
11 |
|
12 | You can install the package globally and use it as command line tool:
|
13 |
|
14 |
|
15 | ```sh
|
16 | $ npm i -g idea
|
17 | ```
|
18 |
|
19 |
|
20 | Then, run `idea --help` and see what the CLI tool can do.
|
21 |
|
22 |
|
23 | ```
|
24 | $ idea --help
|
25 | idea help
|
26 | usage: idea [command] <idea|filter|id>
|
27 |
|
28 | A lightweight CLI tool and module for keeping your ideas in a safe place quick and easy.
|
29 |
|
30 | [command]
|
31 | create <idea> Creates and saves a new idea. Example: `idea create "Implement something very cool"`
|
32 | list Lists all ideas. Example: `idea list`
|
33 | filter <filter> Lists filtered ideas. Example: `idea filter '{"state": "SOLVED"}'`
|
34 | solve <id> Solves an idea. Example `idea solve 1`
|
35 | help Prints this help.
|
36 |
|
37 | Documentation can be found at https://github.com/IonicaBizau/idea
|
38 | ```
|
39 |
|
40 | ## :clipboard: Example
|
41 |
|
42 |
|
43 | Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm`:
|
44 |
|
45 | ```sh
|
46 | $ npm i --save idea
|
47 | ```
|
48 |
|
49 |
|
50 |
|
51 | ```js
|
52 | // Dependencies
|
53 | var Idea = require("idea");
|
54 |
|
55 | // Initialize the idea object
|
56 | var idea = new Idea("./ideas.json", err => {
|
57 | if (err) throw err;
|
58 | idea.create("Implement something cool.", err => {
|
59 | if (err) throw err;
|
60 | });
|
61 | });
|
62 | ```
|
63 |
|
64 | ## :question: Get Help
|
65 |
|
66 | There are few ways to get help:
|
67 |
|
68 | 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
|
69 | 2. For bug reports and feature requests, open issues. :bug:
|
70 | 3. For direct and quick help from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
|
71 |
|
72 |
|
73 | ## :memo: Documentation
|
74 |
|
75 | For full API reference, see the [DOCUMENTATION.md][docs] file.
|
76 |
|
77 | ## :yum: How to contribute
|
78 | Have an idea? Found a bug? See [how to contribute][contributing].
|
79 |
|
80 |
|
81 | ## :sparkling_heart: Support my projects
|
82 |
|
83 | I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously,
|
84 | this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
|
85 |
|
86 | However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
|
87 |
|
88 | - Starring and sharing the projects you like :rocket:
|
89 | - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
90 | - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
|
91 | - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
|
92 |
|
93 | ![](https://i.imgur.com/z6OQI95.png)
|
94 |
|
95 | Thanks! :heart:
|
96 |
|
97 |
|
98 |
|
99 | ## :scroll: License
|
100 |
|
101 | [MIT][license] © [Ionică Bizău][website]
|
102 |
|
103 | [badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
|
104 | [badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
|
105 | [badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
|
106 | [badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg
|
107 | [patreon]: https://www.patreon.com/ionicabizau
|
108 | [amazon]: http://amzn.eu/hRo9sIZ
|
109 | [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
|
110 | [donate-now]: http://i.imgur.com/6cMbHOC.png
|
111 |
|
112 | [license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
|
113 | [website]: https://ionicabizau.net
|
114 | [contributing]: /CONTRIBUTING.md
|
115 | [docs]: /DOCUMENTATION.md
|