Skip to content
This repository was archived by the owner on Jun 5, 2019. It is now read-only.

Commit 4951e2c

Browse files
authored
Merge pull request #88 from skellock/update-readme
Updates the readme with a little more details.
2 parents d77b574 + 9e4f8e5 commit 4951e2c

File tree

1 file changed

+80
-4
lines changed

1 file changed

+80
-4
lines changed

README.md

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,89 @@
66

77
# electron-starter
88

9-
This is a electron starter kit from some random guy on the Internet.
9+
This is a `TypeScript` and `React` starter kit for building Electron apps.
1010

11-
[Check out the docs](https://skellock.github.io/electron-starter) for all the gory details.
11+
[Check out the docs](https://skellock.github.io/electron-starter) for some of the choices and motivations.
1212

13-
# example
13+
14+
### Example
15+
16+
You have to bring your own awesome. But here's a picture* after `npm i` and `npm start` and `npm storybook`...
1417

1518
<img src='./docs/demo.gif' width='450' />
1619

17-
It's not much to look at really. Just a barebones boilerplate. You need to bring your own awesome.
20+
><small>* What it looks like moments before you hit the delete button to nuke all the staged features..</small>
21+
22+
23+
# Out of the Box
24+
25+
### Electron Features 💫
26+
27+
* ability to build all 3 platforms on your mac
28+
* auto-update your apps!
29+
* a simple library for css styling
30+
* fast & fluid animation engine
31+
* fantastic keyboard support
32+
* save window position between launches
33+
* persist application data as JSON
34+
* sane styling defaults on windows, mac, and linux
35+
36+
### Devs Like Nice Things Too 🔨
37+
38+
* super-fast hot reloading 🔥
39+
* lean production bundles
40+
* integrated storybook support
41+
* unit tests with mocking
42+
* 100% code coverage with examples on how to keep it there
43+
* code linting & formatting
44+
45+
### Documentation & Samples 🖨
46+
47+
* how to quickly jettison parts you don't want
48+
* why we chose the stack we did
49+
* how to structure your electron app
50+
* a simple & co-located approach to building your components
51+
52+
### Not Included 💣
53+
54+
* lock in... keep what works for you, ditch the rest
55+
* state management... `mobx`? / `redux`? ... both awesome. both excluded.
56+
* a component toolkit
57+
58+
59+
# License 🎤
60+
61+
You down with MIT?
62+
63+
64+
# Contributors
65+
66+
<table>
67+
<tr>
68+
<td align='center'>
69+
<a href='https://github.com/skellock'><img src='https://avatars2.githubusercontent.com/u/68273?v=4&s=400' width='120' style='border-radius: 10px;' ><br>
70+
@skellock
71+
</a>
72+
</td>
73+
<td align='center'>
74+
<a href='https://github.com/rmevans9'><img src='https://avatars2.githubusercontent.com/u/14151327?v=4&s=400' width='120' style='border-radius: 10px;' ><br>
75+
@rmevans9
76+
</a>
77+
</td>
78+
</tr>
79+
</table>
80+
81+
<!--
82+
Did i just use a <table> to do css layout?
83+
84+
Yes. I believe I just did.
85+
86+
👊
87+
88+
89+
90+
91+
92+
🎤
1893
94+
-->

0 commit comments

Comments
 (0)