From e34911a6cb154e574bcdc13c7c4960539f6502ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Freitas?= <1160907@isep.ipp.pt> Date: Sat, 17 Jun 2023 19:00:32 +0100 Subject: [PATCH] docs: explanation, demo, instructions --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 99a3af6..a5fc15c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ -# github-bookmark +# github-bookmark 📖 A micro browser extension that saves a web page URL as a GitHub issue +## Why? + +Everyday I share an article I've read in my [blog](https://joaomagfreitas.link/reads). Usually I bookmark articles to read in the next few days, but I rarely access my bookmark folder to revisit them 🤷 My solution for this problem is to post the articles I certainly know I want to read, as an issue in my blog GitHub repository. This extension helps me automate the process of creating the issue, by mimicking the process of bookmarking a page in the browser. + +## How does it looks like? + +https://github.com/cobrinhas/github-bookmark/assets/26190214/3b2df06a-f7d6-45d1-82fb-e14d3adeaef1 + +## How do I install it? + +1. Clone this repo +2. Install dependencies (`npm i`) +3. Build the extension (`npm run build`) +4. Import the extension (Chrome > Navigate to extensions `chrome://extensions/` > Load Unpacked > Select `dist` folder available in the repo) + +--- + ## Scripts - `npm run build` to transpile and bundle files in `.cjs`, `.js`, `.d.ts` and respective source-maps @@ -19,14 +36,3 @@ This repository is configured with client-side Git hooks that automatically form ```bash ./hooks/INSTALL ``` - ---- - -### Contact - -This template was prepared by: - -- João Freitas, @freitzzz -- Rute Santos, @rutesantos4 - -Contact us for freelancing work!