X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=README;h=ee34529094842e52b3399903393ef007d7214ab5;hp=b698a53b1165b5eec22bd8403a9d44a92ad39ad3;hb=4bd77045bbad0aa6bdb8172d396a8cea7225c07e;hpb=7b56d7a5d272879bc2b48f751935fda86347c438

diff --git a/README b/README
index b698a53..ee34529 100644
--- a/README
+++ b/README
@@ -3,24 +3,25 @@ README
 -------------------------------------------------------------------------------
 
 The sigrok project aims at creating a portable, cross-platform,
-Free/Libre/Open-Source logic analyzer software that supports various
-logic analyzer hardware products.
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
 
 libsigrokdecode is a shared library written in C which provides the basic
 API for running sigrok protocol decoders. The protocol decoders themselves
 are written in Python.
 
 
-Status and API
---------------
+Status
+------
 
-The libsigrokdecode project is currently work in progress.
+libsigrokdecode is in a usable state and has had official tarball releases.
 
-IMPORTANT: The API of libsigrokdecode is NOT yet considered stable! Please do
-           not rely on it, yet! Changes to function names, macro names etc.
-           can happen at any time without prior notice!
+While the API can change from release to release, this will always be
+properly documented and reflected in the package version number and
+in the shared library / libtool / .so-file version numbers.
 
-           The same applies for the API of the Python protocol decoders!
+However, there are _NO_ guarantees at all for stable APIs in git snapshots!
+Distro packagers should only use released tarballs (no git snapshots).
 
 
 Requirements
@@ -33,7 +34,7 @@ Requirements
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.22.0
+ - libglib >= 2.28.0
  - Python >= 3.0
 
 
@@ -42,8 +43,8 @@ Building and installing
 
 In order to get the libsigrokdecode source code and build it, run:
 
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/libsigrokdecode
+ $ git clone git://sigrok.org/libsigrokdecode
+ $ cd libsigrokdecode
  $ ./autogen.sh
  $ ./configure
  $ make
@@ -78,5 +79,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrokdecode