author | Giulio Cesare Solaroli <giulio.cesare@clipperz.com> | 2013-04-26 09:47:45 (UTC) |
---|---|---|
committer | Giulio Cesare Solaroli <giulio.cesare@clipperz.com> | 2013-04-26 09:47:45 (UTC) |
commit | 6336f032985eb14a21fd089d322002210095a0a7 (patch) (unidiff) | |
tree | 157ac3be4b0f89f7cec2d1f8cfedfd14387b417e | |
parent | 108dd23db8fdc9512446be708d2694f3050b1d8f (diff) | |
download | clipperz-6336f032985eb14a21fd089d322002210095a0a7.zip clipperz-6336f032985eb14a21fd089d322002210095a0a7.tar.gz clipperz-6336f032985eb14a21fd089d322002210095a0a7.tar.bz2 |
Updated README
-rw-r--r-- | README.md | 19 |
1 files changed, 14 insertions, 5 deletions
@@ -1,6 +1,7 @@ | |||
1 | # ![Clipperz icon][icon] CLIPPERZ - Online Password Manager | 1 | # ![Clipperz icon][icon] CLIPPERZ - Online Password Manager |
2 | 2 | ||
3 | [icon]: ./Icon.png | ||
3 | 4 | ||
4 | ##What does Clipperz do? | 5 | ##What does Clipperz do? |
5 | 6 | ||
6 | Clipperz is an online vault where you can store confidential data without worrying about security. It can be used to save and manage passwords, private notes, burglar alarm codes, credit and debit card details, PINs, software keys, … | 7 | Clipperz is an online vault where you can store confidential data without worrying about security. It can be used to save and manage passwords, private notes, burglar alarm codes, credit and debit card details, PINs, software keys, … |
@@ -17,15 +18,27 @@ Read more on the [Clipperz website][home]. | |||
17 | Because we want to enable as many people as possible to play with our code. So that you can start trusting it, the code not the developers. | 18 | Because we want to enable as many people as possible to play with our code. So that you can start trusting it, the code not the developers. |
18 | 19 | ||
19 | In order to allow you to inspect the code and analyze the traffic it generates between client and server, we had to provide an easy way to locally deploy the whole service. | 20 | In order to allow you to inspect the code and analyze the traffic it generates between client and server, we had to provide an easy way to locally deploy the whole service. |
20 | 21 | ||
21 | Feel free to host on your machine a web service identical to [Clipperz online password manager][clipperz]. You can choose among **multiple backends** (PHP/MySQL, Python/AppEngine, …) or you can [contribute][CA] your own. | 22 | Feel free to host on your machine a web service identical to [Clipperz online password manager][home]. You can choose among **multiple backends** (PHP/MySQL, Python/AppEngine, …) or you can [contribute][CA] your own. |
22 | 23 | ||
23 | Whatever is your motivation, we would love to hear from you: [get in contact!][contact] | 24 | Whatever is your motivation, we would love to hear from you: [get in contact!][contact] |
24 | 25 | ||
25 | [CA]: http://www.clipperz.com/open_source/contributor_agreement | 26 | [CA]: http://www.clipperz.com/open_source/contributor_agreement |
26 | [contact]: http://www.clipperz.com/about/contacts | 27 | [contact]: http://www.clipperz.com/about/contacts |
27 | 28 | ||
29 | |||
30 | ## Donations | ||
31 | If you like what Clipperz is building, its openness and its view of cryptography as a powerful tool for liberty, then you may consider making a donation. | ||
32 | |||
33 | Our favorite payment method is clearly Bitcoin ([learn why here][why]), but you can also send your donation via credit card, Paypal or bank transfer. In all cases there will be no link between your real identity and your encrypted data stored on Clipperz. | ||
34 | |||
35 | **To make your donation visit [this page][donations]. Thanks!** | ||
36 | |||
37 | [why]: http://www.clipperz.com/pricing/why_bitcoin | ||
38 | [donations]: http://www.clipperz.com/donations | ||
39 | |||
40 | |||
28 | ## License | 41 | ## License |
29 | ALL the code included in this project, if not otherwise stated, is released with the [AGPL v3][agpl] license (see `LICENSE.txt`), and all rights are reserved to Clipperz Srl. For any use not allowed by the AGPL license, please [contact us][contact] to inquire about licensing options for commercial applications. | 42 | ALL the code included in this project, if not otherwise stated, is released with the [AGPL v3][agpl] license (see `LICENSE.txt`), and all rights are reserved to Clipperz Srl. For any use not allowed by the AGPL license, please [contact us][contact] to inquire about licensing options for commercial applications. |
30 | 43 | ||
31 | [agpl]: http://www.gnu.org/licenses/agpl.html | 44 | [agpl]: http://www.gnu.org/licenses/agpl.html |
@@ -34,9 +47,8 @@ ALL the code included in this project, if not otherwise stated, is released with | |||
34 | ## Warnings | 47 | ## Warnings |
35 | Please note that the open source version of Clipperz Password Manager may not be suitable for mass deployments, depending on how robust is the backend you select. As an example, the current PHP backend lacks several critical capabilities such as bot protection and concurrent sessions management. | 48 | Please note that the open source version of Clipperz Password Manager may not be suitable for mass deployments, depending on how robust is the backend you select. As an example, the current PHP backend lacks several critical capabilities such as bot protection and concurrent sessions management. |
36 | 49 | ||
37 | ## Contributions | 50 | ## Contributions |
38 | |||
39 | Your contributions to Clipperz are very welcome! In order to avoid jeopardizing the ownership of the code base, we will require every developer to sign the Clipperz [Contributor Agreement][CA] | 51 | Your contributions to Clipperz are very welcome! In order to avoid jeopardizing the ownership of the code base, we will require every developer to sign the Clipperz [Contributor Agreement][CA] |
40 | 52 | ||
41 | This enables a single entity to represent the aggregated code base and gives the community flexibility to act as a whole to changing situations. | 53 | This enables a single entity to represent the aggregated code base and gives the community flexibility to act as a whole to changing situations. |
42 | 54 | ||
@@ -45,9 +57,8 @@ The CA establishes a joint copyright assignment in which the contributor retains | |||
45 | Please [download][CA] and review the Contributor Agreement for a complete understanding of its terms and conditions. You may send your signed and completed CA to Clipperz by scanning your completed form and emailing the image or by fax. Please retain a copy for your records. **Thanks!** | 57 | Please [download][CA] and review the Contributor Agreement for a complete understanding of its terms and conditions. You may send your signed and completed CA to Clipperz by scanning your completed form and emailing the image or by fax. Please retain a copy for your records. **Thanks!** |
46 | 58 | ||
47 | 59 | ||
48 | ## Building | 60 | ## Building |
49 | |||
50 | In order to build the deployable version, you need to invoke the following command: | 61 | In order to build the deployable version, you need to invoke the following command: |
51 | 62 | ||
52 | git clone git@github.com:clipperz/password-manager.git | 63 | git clone git@github.com:clipperz/password-manager.git |
53 | cd password-manager | 64 | cd password-manager |
@@ -77,8 +88,6 @@ Besides PHP and Python, more backends are in the works, most notably a node.js v | |||
77 | ## Disclaimer | 88 | ## Disclaimer |
78 | 89 | ||
79 | The resulting application has not been fully tested, so there may be still problems due to the new build script or some other changes that were done due to the new repository structure. So, for the moment, **use it at your own risk!** | 90 | The resulting application has not been fully tested, so there may be still problems due to the new build script or some other changes that were done due to the new repository structure. So, for the moment, **use it at your own risk!** |
80 | 91 | ||
81 | [icon]: http://0.gravatar.com/avatar/2a9fae49ced80a42830a206f88ea1022?size=100 | ||
82 | [clipperz]: http://www.clipperz.com | ||
83 | 92 | ||
84 | [pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file | 93 | [pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file |