From 3ffdac301a836aba35a0464b5b776a367dc5cfb9 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 17 Aug 2021 21:06:44 +0200 Subject: [PATCH] Updated readme --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 3d0d927..6bb27e4 100644 --- a/README.md +++ b/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