From 313b5d34d256f4c79df897f21446d5928a27e96d Mon Sep 17 00:00:00 2001 From: El RIDO Date: Mon, 22 Aug 2016 10:34:37 +0200 Subject: [PATCH] updating docs --- CHANGELOG.md | 4 ++-- CREDITS.md | 2 +- INSTALL.md | 11 ++++++----- LICENSE.md | 20 ++++++++++---------- README.md | 9 +++++---- 5 files changed, 24 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f860eb..85c11ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # PrivateBin version history - * **next release (2016-XX-XX)** + * **next release (2016-08-25)** * ADDED: Translations for Slowene and Chinese * ADDED: re-introduced (optional) URL shortener support, which was removed back in version 0.16 for privacy concerns * ADDED: Preview tab, helpful for writing markdown code or check the source code rendering @@ -9,7 +9,7 @@ * ADDED: Composer support * CHANGED: Renamed the ZeroBin fork to PrivateBin * CHANGED: Removed unmaintained RainTPL template engine, replacing the templates with straight forward PHP files - * CHANGED: New favicon + * CHANGED: New logo and favicons * CHANGED: Upgrading SJCL library to 1.0.4 * CHANGED: Switched to GCM instead of CCM mode for AES encryption for newly created pastes * CHANGED: Use backported random bytes function from PHP7 for older PHP versions instead of mcrypt diff --git a/CREDITS.md b/CREDITS.md index 7460a2c..bf3525d 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -11,7 +11,7 @@ Simon Rupf - current developer and maintainer * Viktor Stanchev - File upload support * azlux - Tab character input support * Adam Fisher - Favicons -* rugk - various stuff, icons +* rugk - various stuff, logo and icons * Sobak - PSR-4 and PSR-2 refactoring Translations: diff --git a/INSTALL.md b/INSTALL.md index 539366b..7f8c59a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -2,7 +2,7 @@ **TL;DR:** Download the [latest release archive](https://github.com/PrivateBin/PrivateBin/releases/latest) -and extract it in your web hosts folder were you want to install your PrivateBin +and extract it in your web hosts folder where you want to install your PrivateBin instance. We try to provide a safe default configuration, but advise you to check the options and adjust them as you see fit. @@ -24,7 +24,7 @@ the options and adjust them as you see fit. ### Configuration In the file `cfg/conf.ini` you can configure PrivateBin. A `cfg/conf.ini.sample` -is provided containing all options on default values. You can copy it to +is provided containing all options and default values. You can copy it to `cfg/conf.ini` and adapt it as needed. The config file is divided into multiple sections, which are enclosed in square brackets. @@ -42,9 +42,10 @@ More details can be found in the In the index.php you can define a different `PATH`. This is useful to secure your installation. You can move the configuration, data files, templates and PHP -libraries (directories cfg, data, lib, tpl, tst and vendor) outside of your document -root. This new location must still be accessible to your webserver / PHP process -([open_basedir setting](https://secure.php.net/manual/en/ini.core.php#ini.open-basedir)). +libraries (directories cfg, doc, data, lib, tpl, tst and vendor) outside of your +document root. This new location must still be accessible to your webserver / PHP +process (see also +[open_basedir setting](https://secure.php.net/manual/en/ini.core.php#ini.open-basedir)). > #### PATH Example > Your PrivateBin installation lives in a subfolder called "paste" inside of diff --git a/LICENSE.md b/LICENSE.md index 6e0d308..05a4125 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -597,16 +597,16 @@ You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: -* **(a)** You must give any other recipients of the Work or Derivative Works a copy of -this License; and -* **(b)** You must cause any modified files to carry prominent notices stating that You -changed the files; and -* **(c)** You must retain, in the Source form of any Derivative Works that You distribute, -all copyright, patent, trademark, and attribution notices from the Source form -of the Work, excluding those notices that do not pertain to any part of the -Derivative Works; and -* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any -Derivative Works that You distribute must include a readable copy of the +* **(a)** You must give any other recipients of the Work or Derivative Works a +copy of this License; and +* **(b)** You must cause any modified files to carry prominent notices stating +that You changed the files; and +* **(c)** You must retain, in the Source form of any Derivative Works that You +distribute, all copyright, patent, trademark, and attribution notices from the +Source form of the Work, excluding those notices that do not pertain to any part +of the Derivative Works; and +* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, +then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the diff --git a/README.md b/README.md index eadc383..c04d961 100644 --- a/README.md +++ b/README.md @@ -76,11 +76,11 @@ file](https://github.com/PrivateBin/PrivateBin/wiki/Configuration): * Password protection -* Discussions +* Discussions, anonymous or with nicknames and IP based identicons or vizhashes * Expiration times, including a "forever" and "burn after reading" option -* Markdown format support for HTML formatted pastes +* Markdown format support for HTML formatted pastes, including preview function * Syntax highlighting for source code using prettify.js, including 4 prettify themes @@ -88,8 +88,9 @@ file](https://github.com/PrivateBin/PrivateBin/wiki/Configuration): * File upload support, images get displayed (disabled by default, possibility to adjust size limit) -* Templates: By default there is a bootstrap CSS and a "classic ZeroBin" theme - and it is easy to adapt these to your own websites layout or create your own. +* Templates: By default there are bootstrap CSS, darkstrap and "classic ZeroBin" + themes and it is easy to adapt these to your own websites layout or create + your own. * Translation system and automatic browser language detection (if enabled in browser)