Update project files

CONTRIBUTING.md

@@ -8,8 +8,36 @@ This project uses the following technologies/standards.
 Please read and understand them before starting.      
 
 - [JavaScript](mdn-js)    - The programming language.
-- [AirBnB JavaScript Style Guide](https://github.com/airbnb/javascript)
 - [Yarn][yarn]            - Package manager
+- [Web-ext][web-ext]      - CLI Web-ext tool
 
+## Setting up your environment
+
+You will just need to install project and component dependencies via yarn
+
+Slate remove your node_modules and do a clean install
+```sh
+npm run slate
+```
+
+## Try on a browser
+
+To try it on a browser, you just need to start the with the command below and set your shaarli URL.         
+```sh
+npm run start # web-ext run
+```
+
+## Running Tests
+
+There is no tests for now.      
+
+## Linting
+
+## Building
+This will create a xpi that can be submitted on [addons.mozilla.org](https://addons.mozilla.org/fr/firefox/)
+```sh
+npm run build # web-ext build
+``
 
 [yarn]: https://yarnpkg.com/en/docs/install "Package manager"
+[web-ext]: https://www.npmjs.com/package/web-ext "CLI Web-Ext tool"

README.md

@@ -1,19 +1,22 @@
 # Shaarli Web Extension
-
+Share your link to your Shaarli on Firefox Quantum.         
 This add-on add a button allowing to share your current tab to your shaarli.        
 
+**NB**: Shaarli is a minimalist link sharing service that you can install on your own server.           
+See [shaarli](https://github.com/shaarli/Shaarli).      
+
+## Why this project
 [Aeris](https://bitbucket.org/aeris/shaarli-extension) made a really cool extension but with firefox version 57 (Quantum) the extension has become obsolete.    
 So here we go for a Firefox Quantum Web-Extension.
 
-# Features
+## Features
 - Set your shaarli URL in add-on settings
 - Share your link with main button action
 
-## TODO
+### TODO
 - Add button menu with action:
   - Share link
   - Go to shaarli
 
-
-# LICENSE
+## LICENSE
 The project is in licence GPL v3, see [LICENCE](LICENCE)

manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "Web Extension for Shaarli",
-  "description": "",
+  "description": "Share your link to your Shaarli on Firefox Quantum",
   "version": "0.0.1",
   "homepage_url": "https://github.com/ikipatang/shaarli-web-extension",
   "manifest_version": 2,

package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaarli-web-extension",
   "version": "0.0.1",
-  "description": "Share your link on Firefox Quantum",
+  "description": "Share your link to your Shaarli on Firefox Quantum",
   "main": "background.js",
   "keywords": [
     "web",