Skip to content

Commit bcfded4

Browse files
committed
Added README
1 parent 2ed382a commit bcfded4

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Build a Secure Desktop App with React and Electron
2+
3+
A small text editor desktop application, called "scratchpad", that automatically saves changes as you type.
4+
5+
Built using Electron and React and [Electron Forge](https://www.electronforge.io/).
6+
7+
## Requirements
8+
9+
* [Node.js](http://nodejs.org/)
10+
11+
## Installation Steps
12+
13+
1. Clone repo
14+
2. Run `npm install`
15+
3. Run `npm run start` to launch the app
16+
4. Run `npm run make` to build the app
17+
18+
## License
19+
20+
SitePoint's code archives and code examples are licensed under the MIT license.
21+
22+
Copyright © 2021 SitePoint
23+
24+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
25+
26+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
27+
28+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29+

0 commit comments

Comments
 (0)