Updated readme
This commit is contained in:
parent
b82a05a1df
commit
3ffdac301a
37
README.md
37
README.md
|
@ -15,6 +15,38 @@ TODO: -->
|
|||
- Click on `Load Unpacked` in the top left
|
||||
- Select the unziped folder ("linkylinky-chrome")
|
||||
|
||||
## 🛠 Dev Setup
|
||||
> Runs on port 3000
|
||||
|
||||
#### Yarn
|
||||
```bash
|
||||
yarn
|
||||
yarn dev
|
||||
```
|
||||
|
||||
#### NPM
|
||||
```bash
|
||||
npm i
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 🚢 Build
|
||||
#### Yarn
|
||||
```bash
|
||||
yarn
|
||||
yarn build
|
||||
# Optional to create the zip
|
||||
yarn build:package
|
||||
```
|
||||
|
||||
#### NPM
|
||||
```bash
|
||||
npm i
|
||||
npm run build
|
||||
# Optional to create the zip
|
||||
npm run build:package
|
||||
```
|
||||
|
||||
## 🏴 Roadmap/ Progress
|
||||
- [x] Basic README
|
||||
- [x] Publish to git
|
||||
|
@ -27,6 +59,11 @@ TODO: -->
|
|||
- [ ] Project Logo™
|
||||
- [x] Basic error handling
|
||||
- [x] Finalize styling
|
||||
- [x] Advanced project stuff
|
||||
- [x] Purge delivered css
|
||||
- [x] Build script
|
||||
- [x] Automagic builds via drone
|
||||
- [x] Delivery as zip
|
||||
|
||||
## Credits
|
||||
* ClipboardJS by Zeno Rocha licensed under MIT - Website: https://clipboardjs.com/ - Repo: https://github.com/zenorocha/clipboard.js
|
||||
|
|
Loading…
Reference in New Issue