Skip to content

Commit 4a60d3d

Browse files
committed
Added readme
1 parent ee923a5 commit 4a60d3d

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Alex Chaplinsky <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# bozon
2+
> Bootstrap, Build, Run and Package Electron application with ease. CoffeeScript and Sass included.
3+
4+
5+
## Installation
6+
7+
8+
```bash
9+
npm install -g bozon
10+
```
11+
12+
Then generate your new project:
13+
14+
```bash
15+
bozon new [name]
16+
```
17+
18+
## Starting an application
19+
Application source code will be compiled to `builds/development` directory and Electron will be run after that.
20+
21+
```bash
22+
bozon start
23+
```
24+
25+
## Packaging application
26+
Application source code will be compiled to `builds/production/[platform]` directories. List of platforms is defined in `package.json` under `packaging` section.
27+
28+
```bash
29+
bozon package
30+
```
31+
32+
## License
33+
34+
MIT © [Alex Chaplinsky]()

0 commit comments

Comments
 (0)