commit 390aa1cbe2c0cd4f05b969f568a6b7b991e4856f Author: juga0 juga@riseup.net Date: Fri Sep 14 17:06:14 2018 +0000
Replace public changes by the version
that will be considered production ready --- README.md | 37 ++----------------------------------- 1 file changed, 2 insertions(+), 35 deletions(-)
diff --git a/README.md b/README.md index 4c1f1b0..f5b98a3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ used by Tor and would only create more traffic in the Tor network. See ./INSTALL.rst) for install instructions, [./DEPLOY.rst](./DEPLOY.rst) for deploy instructions, [./CONTRIBUTING](./CONTRIBUTING.rst) for contribution guidelines. +======= +`sbws` will be considered production ready when version 1.0.0 will be releases.
More extensive documentation can be found in the ./docs directory, also online at https://sbws.readthedocs.io and @@ -38,41 +40,6 @@ also online at https://sbws.readthedocs.io and - `tests/integration/` more complex tests and/or tests that require Tor to be running - `tests/testnets/` scripts and code for running mini Tor networks locally
-### The public API for sbws - -As required by semantic versioning, the public API for sbws will not change -without a major version bump. The public API is - -- **The available configuration options and their defaults**. New options may - be added without a major version bump, but no options will be removed, nor -will defaults be drastically changed. Examples of drastic changes to defaults -include obvious things like changing the default URL for the file to download -or a location for data storage, but also more subjective things, such as -increasing the target download time significantly (6s to 60s). Examples of an -insignificant change include changing the default client nickname. Rule of -thumb: if it is likely to affect results or sbws behavior significantly, it is -a major change. - -- **The name and function of commands**. The command you run to perform certain - actions will not change in a backward incompatible way without a major -version change. For example to generate a v3bw file you will always run `sbws -generate` unless there is a major version bump and the release notes indicate -the command has changed. - -- **The format of output**. Results (stored in `~/.sbws/datadir` by default) - will not change their format in a backward incompatible way without both a -major version bump and a bump in the result version integer. The v3bw file -generated with `sbws generate` will not change its format without a major -version bump. *Log lines and the output of `sbws stats` are exceptions to this -rule*. - -- **NOT the name, location, signature, or existance of python functions**. Sbws - is meant to be ran as a standalone program. It is not at all meant to be -treated or used like a library. Users of sbws do *not* need an understanding of -how its code is laid out. Therefore the code may change drastically without a -major version bump as long as the way users interact with it does not change in -a backward incompatible way. - ## The `.sbws` directory
By default is `~/.sbws`.