Updated readme

RoelVB · Jul 2, 2023 · acaf8ea · acaf8ea
1 parent f722c76
commit acaf8ea
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 21 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -19,7 +19,7 @@ jobs:
         run: npm ci
 
       - name: Build extension
-        run: npm run prod
+        run: npm run build
 
       - name: Upload build
         uses: actions/upload-artifact@v3

diff --git a/Documents/Images/CKPNotConnected.png b/Documents/Images/CKPNotConnected.png
diff --git a/Documents/Images/CKPOptions.png b/Documents/Images/CKPOptions.png
diff --git a/Documents/Images/CKPOptionsConnected.png b/Documents/Images/CKPOptionsConnected.png
diff --git a/Documents/Images/CKPPopup.png b/Documents/Images/CKPPopup.png
diff --git a/Documents/Manuals/Buildinstructions.md b/Documents/Manuals/Buildinstructions.md
@@ -1,11 +1,15 @@
-## ChromeKeePass Build Instructions
+# ChromeKeePass Build Instructions
 
 1. You need to have [NodeJS](https://nodejs.org) installed
 
 2. Run the command `npm install` in the project directory to install all dependencies
 
 3. The build result is always in the `/dist` directory. There are three build commands:
 
-    1. `npm run dev`: This builds the project including source maps (for easy debugging)
+    1. `npm run dev`: This builds the project including source maps and additional console outputs (for easy debugging)
     2. `npm run watch`: This does the same as `dev`, but this command keeps watching for changes in source files and automatically rebuilds when a change is detected
-    3. `npm run prod`: This creates a production build. This means it is minified and without source maps
+    3. `npm run build`: This creates a production build. This means it is minified and without source maps
+
+## Testing
+
+There are automated tests available. You can run them with the command `npm test`, but you can also test manually agains the built-in test webserver. See the [test readme](../../test/readme.md) for more details.
diff --git a/Readme.md b/Readme.md
@@ -1,48 +1,40 @@
 # ChromeKeePass / EdgeKeePass
 
-> Setup instructions below (or see [https://youtu.be/0cVEjYQXrHc](https://youtu.be/0cVEjYQXrHc))
+> Setup instructions below (or see [https://youtu.be/0cVEjYQXrHc](https://youtu.be/0cVEjYQXrHc)) (NOTE! This shows an old version of the extension)
 
 ChromeKeePass/EdgeKeePass is an open source Chrome extension to automatically entering credentials into websites.
 
-The extension depends on [KeePassHttp](https://github.com/pfn/keepasshttp), using this KeePass plugin we're able to create a secure communication between the browserextension and KeePass.
+To use this extension you **need to have KeePass installed** and the [KeePassHttp](https://github.com/pfn/keepasshttp) plugin, using this KeePass plugin we're able to create secure communication between the browser and KeePass.
 
 ![Demo](Documents/Images/DemoMicrosoft.gif)
 
-The goal of this project is to create a user-friendly KeePass integration. With an easily readable and understandable sourcecode.
-
-## Features
-
-- Automatically entering credentials from KeePass into your browser
-- Autocomplete while typing in the username field
-- More to come
-
 ## Setup
 
 1. Make sure you have KeePassHttp installed. Instruction on [how to install](Documents/Manuals/KeePassHttp%20installation.md) KeePassHttp.
 
 2. Make sure KeePass is running, and a password database is opened
 
-3. Click the ChromeKeePass icon next to the address bar, it'll show 'Disconnected', click the gear to go to the options
+3. Click the extension's icon next to the address bar, it'll show 'Disconnected', click the gear to go to the options
 
    ![ChromeKeePass Popup](Documents/Images/CKPPopup.png)
 
-4. The ChromeKeePass options open, click the `Connect` button
+4. The options window opens, click the `Connect` button
 
-   ![ChromeKeePass options](Documents/Images/CKPOptions.png)
+   ![ChromeKeePass options](Documents/Images/CKPNotConnected.png)
 
 5. A KeePass dialog will open, enter a desired name and click `Save`
 
    ![KeePassHttp Associate](Documents/Images/CKPAssociation.png)
 
-6. The ChromeKeePass options dialog will now show it is connected
+6. The options dialog will now show it is connected
 
    ![ChromeKeePass Connected](Documents/Images/CKPOptionsConnected.png)
 
-7. The encryption key (for secure communication between KeePass en ChromeKeePass) is stored inside your KeePass database under the entry 'KeePassHttp Settings'
+7. The encryption key (for secure communication between KeePass and the browser) is stored inside your KeePass database under the entry 'KeePassHttp Settings'
 
 ## Contribute to ChromeKeePass
 
-- When contributing, always base you changes on the `dev` branch. The `master` branch contains the currently released version. Pull requests will be merged into the `dev` branch
+- When contributing, always base you changes on the `dev-v2` branch. Pull requests will also be merged into the `dev-v2` branch
 - Try to keep the coding style as consistant as possible
 - You can find build instructions [over here](Documents/Manuals/Buildinstructions.md)
 

diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     },
     "scripts": {
         "dev": "webpack --mode \"development\"",
-        "prod": "webpack --mode \"production\"",
+        "build": "webpack --mode \"production\"",
         "watch": "webpack --mode \"development\" -w",
         "test": "ts-mocha",
         "test:all": "ts-mocha --includeSites",