Jirafeau version 2.0.0

[jirafeau_mojo42.git] / README.md

diff --git a/README.md b/README.md
index bbad04719d4f471be13064f85164c1a3ca234f58..9a09bd3ea9832c886ad8d16e48fa3c13eb089bdc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,6 +80,10 @@ If you don't want to go through the installation wizard, you can just copy ```co
 
 Nothing particular
 
+### from version 1.2.0 to 2.0.0.
+
+1. ToS text file changed → move file from "/tos_text.php" to "/lib/tos.local.txt" and remove all HTML and PHP Tags, leaving a regular text file
+
 ## Security
 
 ```var``` directory contain all files and links. It is randomly named to limit access but you may add better protection to prevent un-authorized access to it.
@@ -120,6 +124,29 @@ By activating this feature, you have to be aware of few things:
 
 In a next step, encryption will be made by the client (in javascript), see issue #10.
 
+## License
+
+GNU Affero General Public License version 3 (AGPLv3).
+
+The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.
+
+Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated, 
+you are required to provide a link to the source code of your version in order to obey the AGPLv3 license. 
+To do so please add a link to the source (eg. a public Git repository or a download link) to the Terms of Service page.
+Take a look at the FAQ to find out about how to change the ToS.
+
+PS: If you have fixed errors or added features, then please contribute to the project and send a merge request with these changes.
+ 
+## Contribution
+
+If you want to contribute to project, then take a look at the git repository:
+
+- https://gitlab.com/mojo42/Jirafeau
+
+and the Contribution Guidelines
+
+- https://gitlab.com/mojo42/Jirafeau/blob/master/CONTRIBUTING.md
+
 ## FAQ
 
 ### Can I add a new language in Jirafeau?
@@ -189,6 +216,14 @@ If you don't want to allow unlimited upload size, you can still setup a maximal
 Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).
 If you want to change an option, just edit your ```lib/config.local.php```.
 
+### How can I change the Terms of Service?
+
+The license text on the "Terms of Service" page, which is shipped with the default installation, is based on the »[Open Source Initiative Terms of Service](https://opensource.org/ToS)«.
+
+To change this text simply copy the file [/lib/tos.original.txt](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/tos.original.txt), rename it to ```/lib/tos.local.txt``` and adapt it to your own needs.
+
+If you update the installation, then only the ```tos.original.txt``` file may change eventually, not your ```tos.local.txt``` file.
+
 ### How can I access the admin interface?
 
 Just go to ```/admin.php```.
@@ -225,14 +260,6 @@ The original project seems not to be continued anymore and I prefer to add more
 
 Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)
 
-### What is the Jirafeau's license?
-
-Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING).
-
-### How do I modify the TOS (terms of use)?
-
-Just edit ```tos.php``` and configure ```$org``` and ```$contact``` variables.
-
 ### What about this file deduplication thing?
 
 Jirafeau uses a very simple file level deduplication for storage optimization.
@@ -297,3 +324,14 @@ The very first version of Jirafeau after the fork of Jyraphe.
 - Default expiration date set to 'month'
 - New expiration date: 'quarter'
 - Small other fixes
+
+## Version 2.0.0
+
+- ToS refactoring (see update notes !)
+- You can now set a title to Jirafeau in options
+- A lot of documentation improvements
+- Code refactoring & bugfixes
+- Add version to bash script
+- A lot of documentation improvements
+- Code refactoring & bug fixes
+-