1 | # 2app
|
2 |
|
3 | Convert web projects into native desktop apps for MacOSX, Linux and Windows useing Electron.
|
4 |
|
5 | ## Installation
|
6 |
|
7 | ```
|
8 | npm install 2app -g
|
9 | ```
|
10 |
|
11 | ## Usage
|
12 |
|
13 | ```
|
14 | 2app [Command]
|
15 | ```
|
16 |
|
17 | Available Commands:
|
18 | * `create`
|
19 | * `pack [src path]`
|
20 |
|
21 | Example Usage:
|
22 | * Create a template file in your current directory: `2app create`
|
23 | * Pack a finished project into native app: `2app pack ./myProject`
|
24 |
|
25 |
|
26 |
|
27 | ## Contributing
|
28 |
|
29 | 1. Fork it!
|
30 | 2. Create your feature branch: `git checkout -b my-new-feature`
|
31 | 3. Commit your changes: `git commit -am 'Add some feature'`
|
32 | 4. Push to the branch: `git push origin my-new-feature`
|
33 | 5. Submit a pull request :D
|
34 |
|
35 | ## History
|
36 |
|
37 | TODO: Write history
|
38 |
|
39 | ## Credits
|
40 |
|
41 | TODO: Write credits
|
42 |
|
43 | ## License
|
44 |
|
45 | This project is available under the MIT license. See LICENSE for details. |
\ | No newline at end of file |