README.md

@@ -1,2 +1,36 @@
-# EnhancedAniwatch
+# Aniwatch Plus
-Enhancment extension for https://aniwatch.me/
+*Aniwatch Plus* is an unofficial extension which provides several UI improvments for https://aniwatch.me. 
+
+## Features
+* adds quick search to website
+* cleaner style for lists
+* better presentation of anime requests
+
+## Browser Support
+We currently support the following browsers in current versions:
+* Google Chrome
+* Mozilla Firefox
+* Opera
+* Microsoft Edge
+
+### Installation
+This extension isn´t available in browser stores yet. Please download from [releases](https://github.com/Serraniel/AniwatchPlus/releases) for your browser and check how to manually install an extension into your browser. If you want to install the extension in Microsoft Edge, please use the Chrome release version.
+
+## Development
+### Tools
+This project requires you to install [NPM](https://nodejs.org/en/download/) and [gulp](https://www.npmjs.com/package/gulp).
+
+### Build
+```sh
+# mandatory
+npm install -d
+
+# build release version into './dist'
+npm run dist:prod
+
+# build dev version into './div' and start the watcher
+npm run watch
+
+# clean build and dist directories
+npm run clean
+```

package.json

@@ -1,10 +1,11 @@
 {
-    "name": "enhancedaniwatch",
+    "name": "aniwatch-plus",
-    "version": "1.0.0",
+    "version": "0.1.0.0-beta",
-    "description": "Ehanced Aniwatch is a browser extension for https://aniwatch.me/",
+    "description": "Aniwatch Plus is a browser extension for https://aniwatch.me/",
     "main": "index.js",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
+        "clean": "gulp clean",
         "build": "gulp build",
         "build:prod": "cross-env NODE_ENV=production gulp build",
         "dist": "gulp dist",
@@ -13,14 +14,20 @@
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/Serraniel/EnhancedAniwatch.git"
+        "url": "git+https://github.com/Serraniel/AniwatchPlus.git"
     },
-    "author": "Serraniel",
+    "author": {
+        "name": "Serraniel",
+        "email": "mail@serraniel.dev",
+        "url": "https://serraniel.dev"
+    },
+    "contributors": [],
     "license": "MPL-2.0",
     "bugs": {
-        "url": "https://github.com/Serraniel/EnhancedAniwatch/issues"
+        "url": "https://github.com/Serraniel/AniwatchPlus/issues",
+        "email": "mail@serraniel.dev"
     },
-    "homepage": "https://github.com/Serraniel/EnhancedAniwatch#readme",
+    "homepage": "https://github.com/Serraniel/AniwatchPlus#readme",
     "dependencies": {
         "regenerator-runtime": "^0.13.7"
     },