Updated Readme

README.md

@@ -1,73 +1,44 @@
-# sp-fx-app-dev-simple-password-vault
+# SPFx Password Vault Webpart
 
 ## Summary
 
-Short summary on functionality and used technologies.
+This webpart allows you to protect your data, such as the username, password or even just a text note (rich text). This data is protected with a master password that you can choose yourself. 
+The data is encrypted and stored in the properties of the webpart. This means that the data is not in plain text and can only be decrypted by entering the master password. You can also use this web part in SharePoint and Microsoft Teams (as a tab)
 
-[picture of the solution in action, if possible]
+### Display Mode
+![Webpart Display mode closed vault](./images/WP_Displaymode_Closed.png)
+
+![Webpart Edit mode open vault](./images/WP_Displaymode_Open.png)
+
+### Edit Mode
+![Webpart Edit mode](./images/WP_Editmode.png)
+
+### Maintenance Mode
+![Maintenancemode shows the stored data](./images/WP_Maintenancemode.png)
+
+
+## Download
+
+You can download the solution from here: https://github.com/SPFxAppDev/sp-passwordvault-webpart/releases
 
 ## Used SharePoint Framework Version
 
-![version](https://img.shields.io/npm/v/@microsoft/sp-component-base/latest?color=green)
+SPFx: 1.12.1 
 
-## Applies to
 
-- [SharePoint Framework](https://aka.ms/spfx)
-- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
-
-> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
-
-## Prerequisites
-
-> Any special pre-requisites?
+## 
 
 ## Solution
 
 Solution|Author(s)
 --------|---------
-folder name | Author details (name, company, twitter alias with link)
+spfxappdev-simple-password-vault.sppkg | Seryoga https://spfx-app.dev/ 
 
 ## Version history
 
 Version|Date|Comments
 -------|----|--------
-1.1|March 10, 2021|Update comment
-1.0|January 29, 2021|Initial release
+1.0.0| March 22, 2022| Initial release
 
-## Disclaimer
-
-**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
 
 ---
-
-## Minimal Path to Awesome
-
-- Clone this repository
-- Ensure that you are at the solution folder
-- in the command-line run:
-  - **npm install**
-  - **gulp serve**
-
-> Include any additional steps as needed.
-
-## Features
-
-Description of the extension that expands upon high-level summary above.
-
-This extension illustrates the following concepts:
-
-- topic 1
-- topic 2
-- topic 3
-
-> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance.
-
-> Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp.
-
-## References
-
-- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
-- [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview)
-- [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
-- [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview)
-- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development