summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVitaly Minko <vitaly.minko@gmail.com>2019-10-10 07:01:15 +0300
committerVitaly Minko <vitaly.minko@gmail.com>2019-10-10 07:01:15 +0300
commit8098629eebea04b998c64ef092674771d5911738 (patch)
tree437fdf716522b7f29ebc834f935a852ddd7613fe
parent4aa1f703708f06737dca39f64515ff8e62a0536b (diff)
Prepared documentation for v0.1 release.HEADv0.1master
-rw-r--r--README.md36
-rw-r--r--docs/dscuss.mkd41
-rw-r--r--docs/setup.mkd4
3 files changed, 42 insertions, 39 deletions
diff --git a/README.md b/README.md
index a8cfa5e..2c93af3 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,21 @@ API description generated by godoc is available [here][godoc].
Progress of development
-----------------------
-The current stable version is proof-of-work. It has the following features:
+The version 0.2 is under development. The following features are planned for
+this version:
+
+* Relay servers (improved connectivity).
+* SPAM resistance (improved security).
+* Message text formatting.
+
+The current stable version is 0.1. It has the following new features:
+
+* Database synchronization with other peers.
+* Web interface.
+* Improved connectivity (bootstrapping via DHT).
+* Improved security (flood resistance).
+
+Features implemented in the proof-of-concept version:
* Command-line interface.
* Basic security based on ECDSA.
@@ -78,18 +92,6 @@ The current stable version is proof-of-work. It has the following features:
* Threading (replying to messages).
* Operations on messages and users.
-The version 0.1 is under development. The following features are already
-implemented:
-
-* Database synchronization with other peers.
-* Improved connectivity (bootstrapping via DHT).
-* Web interface.
-* Improved security (flood resistance).
-
-The following additional features are planned for version 0.1:
-
-* Improved security (SPAM resistance).
-
Dependencies
------------
@@ -119,16 +121,16 @@ How to get the source code
The source code is available under GPL3.
-To fetch the latest source code from the main git repository, run the following command:
+To fetch the latest source code from the main git repository, run the following
+command:
git clone git://vminko.org/dscuss
GitHub contains the backup Dscuss repository: [github.com/vminko/dscuss][github].
+If you want to get the version 0.1 (which is more or less stable):
-If you want to get the proof-of-concept version (which is more or less stable):
-
- git reset --hard proof-of-concept
+ git reset --hard v0.1
You can use the [web interface][cgit] to browse the source code online.
diff --git a/docs/dscuss.mkd b/docs/dscuss.mkd
index 578bcfb..6c42132 100644
--- a/docs/dscuss.mkd
+++ b/docs/dscuss.mkd
@@ -13,7 +13,7 @@ Copyright: (c) 2011-2019 Vitaly Minko
Creative Commons Attribution-Share Alike 3.0 Unported License
Web: http://vminko.org/dscuss
Sort by: Date
-Date: 31 Aug 2019
+Date: 9 Oct 2019
Priority: 4
@@ -21,8 +21,7 @@ _<div style="text-align: right">The moderators are dead! Long live the moderator
**Dscuss** is a free software for public discussions. It builds an unstructured
-pure P2P topic-based publish-subscribe network. The current version is
-proof-of-concept.
+pure P2P topic-based publish-subscribe network. The current version is 0.1.
The idea of the project
@@ -65,7 +64,21 @@ API description generated by godoc is available [here][godoc].
Progress of development
-----------------------
-The current stable version is proof-of-work. It has the following features:
+The version 0.2 is under development. The following features are planned for
+this version:
+
+* Relay servers (improved connectivity).
+* SPAM resistance (improved security).
+* Message text formatting.
+
+The current stable version is 0.1. It has the following new features:
+
+* Database synchronization with other peers.
+* Web interface.
+* Improved connectivity (bootstrapping via DHT).
+* Improved security (flood resistance).
+
+Features implemented in the proof-of-concept version:
* Command-line interface.
* Basic security based on ECDSA.
@@ -80,18 +93,6 @@ The current stable version is proof-of-work. It has the following features:
* Threading (replying to messages).
* Operations on messages and users.
-The version 0.1 is under development. The following features are already
-implemented:
-
-* Database synchronization with other peers.
-* Improved connectivity (bootstrapping via DHT).
-* Web interface.
-* Improved security (flood resistance).
-
-The following additional features are planned for version 0.1:
-
-* Improved security (SPAM resistance).
-
Dependencies
------------
@@ -121,16 +122,16 @@ How to get the source code
The source code is available under GPL3.
-To fetch the latest source code from the git repository, run the following command:
+To fetch the latest source code from the main git repository, run the following
+command:
git clone git://vminko.org/dscuss
GitHub contains the backup Dscuss repository: [github.com/vminko/dscuss][github].
+If you want to get the version 0.1 (which is more or less stable):
-If you want to get the proof-of-concept version (which is more or less stable):
-
- git reset --hard proof-of-concept
+ git reset --hard v0.1
You can use the [web interface][cgit] to browse the source code online.
diff --git a/docs/setup.mkd b/docs/setup.mkd
index c18dc8b..84c7916 100644
--- a/docs/setup.mkd
+++ b/docs/setup.mkd
@@ -24,10 +24,10 @@ Clone the git repository:
git clone git://vminko.org/dscuss
-If you want to get the proof-of-concept version (which is more or less stable),
+If you want to get the version 0.1 (which is more or less stable),
then also execute the following command:
- git reset --hard proof-of-concept
+ git reset --hard v0.1
Get the dependencies: