Skip to content

Commit 16d1e30

Browse files
committed
docs(global): update docs
1 parent 33052b4 commit 16d1e30

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
1-
# electron-typescript-react-webpack-tailwind-redux
1+
# electron-typescript-react-tailwind-redux
22

3-
> A secure, modular, and easy to use Electron boilerplate featuring Typescript, React, Webpack, TailwindCSS, Redux and [persistance](https://github.com/saucesteals/electron-persist-secure) (with redux-persist support)
3+
> A secure, modular, and easy to use [Electron Forge](https://www.electronforge.io/) boilerplate featuring [Typescript](https://www.typescriptlang.org/), [React](https://reactjs.org/), [Webpack](https://webpack.js.org/), [TailwindCSS](https://tailwindcss.com/), [Redux](https://redux.js.org/) and [persistance](https://github.com/saucesteals/electron-persist-secure) (with [redux-persist](https://github.com/rt2zz/redux-persist) support)
44
55

66
---
77

88
### **Installation**
99

10-
10+
Clone the repository locally with **none** of its git history
1111
```sh
1212
$ git clone --depth 1 --single-branch https://github.com/saucesteals/electron-typescript-react-tailwind-redux.git your-project-name
1313

1414
$ cd your-project-name
1515

1616
$ yarn
1717
```
18+
### **OR**
19+
20+
Generate a GitHub repository with the [Use this template](https://github.com/saucesteals/electron-typescript-react-tailwind-redux/generate) button above
21+
22+
```sh
23+
$ git clone https://github.com/your-username/your-project-name
24+
25+
$ cd your-project-name
26+
27+
$ yarn
28+
```
29+
1830

1931
---
2032

0 commit comments

Comments
 (0)