Skip to content

Commit ac83345

Browse files
Create README.md
1 parent aecdfef commit ac83345

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
2+
Getting started with electron.js
3+
4+
##
5+
6+
[![Join the chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/divyanshu001)
7+
[![Contact me on Codementor](https://cdn.codementor.io/badges/contact_me_github.svg)](https://www.codementor.io/divyanshurawat?utm_source=github&utm_medium=button&utm_term=divyanshurawat&utm_campaign=github)
8+
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/r46956)
9+
[![DUB](https://img.shields.io/dub/l/vibe-d.svg?style=flat)](#)
10+
11+
[![Divyanshu](https://img.shields.io/badge/divyanshu-owner-brightgreen.svg?style=flat)](http://www.divyanshurawat.in)
12+
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/divyanshu-rawat)
13+
[![NPM](https://img.shields.io/badge/npm-v3.10.10-blue.svg)](https://www.npmjs.com/package/npm)
14+
15+
##
16+
17+
### Description
18+
19+
* A Cross Platform Desktop countDown timer built leveraging the poer of electon.js
20+
21+
##
22+
23+
### Installation Instructions
24+
25+
* Open a command prompt in the project's root directory.
26+
27+
* Cd into that root folder you just cloned locally.
28+
29+
* Open terminal in the current folder and to install all dependencies type
30+
31+
```javascript
32+
npm install
33+
```
34+
35+
* This installs the dependencies as defined in the package.json file
36+
37+
```javascript
38+
npm start
39+
```
40+
41+
* This will run the server in the localhost.
42+
43+
##
44+
45+
46+
### Contributing
47+
48+
1. Create your **_branch_**: `git checkout -b my-new-feature`
49+
50+
2. **_Commit_** your changes: `git commit -m 'Add some feature'`
51+
52+
3. **_Push_** to the branch: `git push origin my-new-feature`
53+
54+
4. Send a **Pull Request**
55+
56+
5. **_Enjoy!_**
57+
58+
##
59+
60+
61+
#### some examples
62+
63+
64+
![alt tag](https://github.com/divyanshu-rawat/getting-started-with-electron.js/blob/master/snapshot/Screen%20Shot%202017-09-19%20at%201.45.54%20AM.png)

0 commit comments

Comments
 (0)