add RSD link to readme (#27)

README.md

@@ -1,14 +1,16 @@
-## Badges
+# Welcome to `scikit-talk`!
+
+`scikit-talk` is an open-source toolkit for processing collections of real-world conversational speech in Python. The toolkit aims to facilitate the exploration of large collections of transcriptions and annotations of conversational interaction.
 
-(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)
+## Badges
 
 | fair-software.eu recommendations | |
 | :-- | :--  |
 | (1/5) code repository              | [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](git@github.com:elpaco-escience/scikit-talk) |
 | (2/5) license                      | [![github license badge](https://img.shields.io/github/license/elpaco-escience/scikit-talk)](git@github.com:elpaco-escience/scikit-talk) |
-| (3/5) community registry           | [![RSD](https://img.shields.io/badge/rsd-scikit-talk-00a3e3.svg)](https://www.research-software.nl/software/scikit-talk) [![workflow pypi badge](https://img.shields.io/pypi/v/scikit-talk.svg?colorB=blue)](https://pypi.python.org/project/scikit-talk/) |
+| (3/5) community registry           | [![RSD](https://img.shields.io/badge/rsd-scikit-talk.svg)](https://research-software-directory.org/software/scikit-talk) [![workflow pypi badge](https://img.shields.io/pypi/v/scikit-talk.svg?colorB=blue)](https://pypi.python.org/project/scikit-talk/) |
 | (4/5) citation                     | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10462997.svg)](https://doi.org/10.5281/zenodo.10462997) |
-| (5/5) checklist                    | [![workflow cii badge](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>/badge)](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
+| (5/5) checklist                    | [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7195/badge)](https://www.bestpractices.dev/projects/7195) |
 | howfairis                          | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) |
 | **Other best practices**           | &nbsp; |
 | Static analysis                    | [![workflow scq badge](https://sonarcloud.io/api/project_badges/measure?project=elpaco-escience_scikit-talk&metric=alert_status)](https://sonarcloud.io/dashboard?id=elpaco-escience_scikit-talk) |
@@ -19,18 +21,15 @@
 | SonarCloud                         | [![sonarcloud](https://github.com/elpaco-escience/scikit-talk/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/elpaco-escience/scikit-talk/actions/workflows/sonarcloud.yml) |
 | Citation data consistency               | [![cffconvert](https://github.com/elpaco-escience/scikit-talk/actions/workflows/cffconvert.yml/badge.svg)](https://github.com/elpaco-escience/scikit-talk/actions/workflows/cffconvert.yml) |
 
+## Installation
 
+`scikit-talk can be installed from PyPI:
 
+```console
+python3 -m pip install scikit-talk
+```
 
-## How to use scikit-talk
-
-Short description of package
-
-The project setup is documented in [project_setup.md](project_setup.md). Feel free to remove this document (and/or the link to this document) if you don't need it.
-
-## Installation
-
-To install scikit-talk from GitHub repository, do:
+Alternatively, you can install the latest development version from GitHub:
 
 ```console
 git clone git@github.com:elpaco-escience/scikit-talk.git
@@ -45,9 +44,11 @@ To read more about the aims of this software, [this paper](https://aclanthology.
 
 ## Contributing
 
-If you want to contribute to the development of scikit-talk,
+If you want to contribute to the development of `scikit-talk,
 have a look at the [contribution guidelines](CONTRIBUTING.md).
 
+Detailed technical information on how to work with the code base can be found in [README.dev.md](README.dev.md).
+
 ## Credits
 
 This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).

docs/index.rst

@@ -6,15 +6,12 @@
 scikit-talk user documentation
 ==============================
 
-Scikit-talk will be an open-source toolkit for processing collections of
+Scikit-talk is an open-source toolkit for processing collections of
 real-world conversational speech in Python. The toolkit aims to facilitate the
 exploration of large collections of transcriptions and annotations of
 conversational interaction, specifically tailored to applications in speech
 processing and Conversational AI.
 
-Scikit-talk is under active development, and currently includes a preprocessor
-module that allows the import of several common transcription formats.
-
 You can read the full paper here: `Liesenfeld et al. (2021) <https://aclanthology.org/2021.sigdial-1.26/>`_
 
 .. toctree::