Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

docs: add README.md for web clipper (#7054)

01zulfi75c346a4607a
diff --git a/extensions/web-clipper/README.md b/extensions/web-clipper/README.md
new file mode 100644
index 000000000..c8303431e
--- /dev/null
+++ b/extensions/web-clipper/README.md
@@ -0,0 +1,30 @@
+# Contributing guidelines
+
+Please read the [contributing guidelines](../../CONTRIBUTING.md) beforehand.
+
+### Setting web clipper locally
+
+#### Running the web clipper
+
+1. Install packages and setup the repo. Run this command in the repository root:
+ ```sh
+ npm install
+ ```
+1. Run the Notesnook webapp:
+ ```sh
+ npm run start:web
+ ```
+1. Navigate to the web clipper folder:
+ ```sh
+ cd extensions/web-clipper
+ ```
+1. Run the web clipper:
+ ```sh
+ npm run dev:chrome
+ ```
+
+#### Viewing the web clipper
+
+1. Open chrome and go to `chrome://extensions`.
+1. Turn on "Developer Mode".
+1. Click on "Load unpacked" and select the `extensions/web-clipper/build` folder.