Merge branch 'fix/add-repo-docs' into 'develop'

Alexandru Cheltuitor · Alexandru Cheltuitor · commit bc51e8751528 · 2021-05-28T09:35:45.000Z
Update repo documentation: contributing, copying and updated readme

See merge request ProtonVPN/linux/proton-python-client!42
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+# Contribution Policy
+
+By making a contribution to this project:
+
+1.    I assign any and all copyright related to the contribution to Proton Technologies AG;
+2.    I certify that the contribution was created in whole by me;
+3.    I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely and may be redistributed with this project or the open source license(s) involved.
diff --git a/COPYING.md b/COPYING.md
@@ -0,0 +1,16 @@
+## Copying
+
+Copyright (c) 2021 Proton Technologies AG
+
+Python Proton Client is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Python Proton Client is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with ProtonVPN. If not, see [https://www.gnu.org/licenses](https://www.gnu.org/licenses/).
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,5 @@
 include LICENSE
 include *.txt
+include *.md
 recursive-include proton *.py
 recursive-include proton *.rst
diff --git a/README.md b/README.md
@@ -1,5 +1,15 @@
-Proton API Python Client
-=============
+# Proton API Python Client
+
+Copyright (c) 2021 Proton Technologies AG
+
+This repository holds the Proton Python Client.
+For licensing information see [COPYING](COPYING.md).
+For contribution policy see [CONTRIBUTING](CONTRIBUTING.md).
+
+## Description
+The Python Proton Client is intended for every Proton service user.
+
+You can download the latest stable release, either from our official repositories or directly on the [official GitHub repository](https://github.com/ProtonMail/proton-python-client/releases/latest).
 
 ## Dependencies
 | **Python** | **Debian** | **Fedora** | **Arch** |
diff --git a/arch/PKGBUILD b/arch/PKGBUILD
@@ -1,7 +1,7 @@
 # Maintainer: Proton Technologies AG <opensource@proton.me>
 pkgname=python-proton-client
 pkgver=0.5.1
-pkgrel=1
+pkgrel=2
 pkgdesc="Safely login with ProtonVPN credentials to connect to Proton."
 arch=("any")
 url="https://github.com/ProtonMail/proton-python-client"
diff --git a/debian/changelog b/debian/changelog
@@ -1,4 +1,4 @@
-proton-python-client (0.5.1-1) unstable; urgency=medium
+proton-python-client (0.5.1-2) unstable; urgency=medium
 
   * Add new exceptions for improved case handling
 
diff --git a/rpmbuild/SPECS/python3-proton-client.spec b/rpmbuild/SPECS/python3-proton-client.spec
@@ -1,6 +1,6 @@
 %define unmangled_name proton-client
 %define version 0.5.1
-%define release 1
+%define release 2
 
 Prefix: %{_prefix}
 
@@ -48,7 +48,7 @@ rm -rf $RPM_BUILD_ROOT
 %defattr(-,root,root)
 
 %changelog
-* Mon May 24 2021 Proton Technologies AG <opensource@proton.me> 0.5.1-1
+* Mon May 24 2021 Proton Technologies AG <opensource@proton.me> 0.5.1-2
 - Add new exceptions for improved case handling
 
 * Fri Apr 30 2021 Proton Technologies AG <opensource@proton.me> 0.5.0-1

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-proton-python-client (0.5.1-1) unstable; urgency=medium`
	`1`	`+proton-python-client (0.5.1-2) unstable; urgency=medium`
`2`	`2`
`3`	`3`	`* Add new exceptions for improved case handling`
`4`	`4`