diff --git a/README.md b/README.md index 067895c6f2..eab9d972f0 100644 --- a/README.md +++ b/README.md @@ -18,25 +18,24 @@ ## License -Passbolt is distributed under [Affero General Public License v3](http://www.gnu.org/licenses/agpl-3.0.html) +Passbolt is distributed under the [Affero General Public License v3](http://www.gnu.org/licenses/agpl-3.0.html) ## About Passbolt -Passbolt is an open source password manager for teams. It allows to securely share and store credentials. -For instance, the wifi password of your office, or the administrator password of a router, or your organisation social media account password, -all of them can be secured using Passbolt. +Passbolt is an open source password manager for teams. It allows you to securely share and store credentials. +For instance, the wifi password of your office, the administrator password of a router or your organisation's social media account passwords, all of them can be secured using passbolt. Passbolt is different from the other password managers because: - It is primarily designed for teams and not individuals - It is free & open source - It is respectful of privacy - It is based on OpenPGP, a proven cryptographic standard -- It is easy to use for both novice and IT professionals alike -- It is extensible thanks to its restful API +- It is easy to use for both novices and IT professionals alike +- It is extensible thanks to its RESTful API -Find out more more : [https://www.passbolt.com](https://www.passbolt.com "Passbolt Homepage") +Find out more: [https://www.passbolt.com](https://www.passbolt.com "Passbolt Homepage") -### How does it look like? +### What does it look like? [![Login](https://raw.githubusercontent.com/passbolt/passbolt_styleguide/master/src/img/screenshots/teaser-screenshot-login-275.png)](https://raw.githubusercontent.com/passbolt/passbolt_styleguide/master/src/img/screenshots/teaser-screenshot-login.png) [![Browse passwords](https://raw.githubusercontent.com/passbolt/passbolt_styleguide/master/src/img/screenshots/teaser-screenshot4-275.png)](https://raw.githubusercontent.com/passbolt/passbolt_styleguide/master/src/img/screenshots/teaser-screenshot4.png) @@ -52,18 +51,17 @@ https://www.passbolt.com/help/start/firefox ## Installing passbolt -You can install passbolt on your own machine. Follow the instructions on the website here +You can install passbolt on your own machine. Follow the instructions on the website here: https://www.passbolt.com/help/tech/install ## Contributing to passbolt -Please checkout CONTRIBUTING.md for more information about how to get involved! +Please check out CONTRIBUTING.md for more information on how to get involved! -## Reporting a security Issue +## Reporting a security issue -If you've found a security related issue in Passbolt, please don't open an issue in GitHub. -Instead contact us at security@passbolt.com. In the spirit of responsible disclosure we ask that the reporter keep the -issue confidential until we announce it. +If you've found a security-related issue in passbolt, please don't open an issue on GitHub. +Instead contact us at security@passbolt.com. In the spirit of responsible disclosure we ask that the reporter keep the issue confidential until we announce it. The passbolt team will take the following actions: - Try first to reproduce the issue and confirm the vulnerability. @@ -72,13 +70,8 @@ The passbolt team will take the following actions: - Prepare a post describing the vulnerability and the possible exploits. - Release new versions of all affected major versions. - Prominently feature the problem in the release announcement. -- Provide credits in the release announcement to the reporter if they so desire. +- Give credit in the release announcement to the reporter if they so desire. ## Credits -Passbolt team rocket: - - [Cédric Alfonsi](https://github.com/cedricalfonsi "Cédric Alfonsi") - - [Rémy Bertot](https://github.com/stripthis "Rémy Bertot") - - [Kevin Muller](https://github.com/kevinmuller "Kevin Muller") - -And also: https://www.passbolt.com/credits +https://www.passbolt.com/credits