Fixes README instructions

leggedrobotics · Feb 7, 2025 · ddcb025 · ddcb025
1 parent aa180f8
commit ddcb025
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@
 Fast and simple implementation of RL algorithms, designed to run fully on GPU.
 This code is an evolution of `rl-pytorch` provided with NVIDIA's Isaac GYM.
 
-| :zap:        The `algorithms` branch supports additional algorithms (SAC, DDPG, DSAC, and more)! |
-| ------------------------------------------------------------------------------------------------ |
+| The `algorithms` branch supports additional algorithms (SAC, DDPG, DSAC, and more)! |
+| ----------------------------------------------------------------------------------- |
 
 The main branch only supports PPO for now.
 Contributions are welcome.
@@ -17,8 +17,8 @@ Contributions are welcome.
 
 The package can be installed via PyPI with:
 
-```
-pip install rsl_rl
+```bash
+pip install rsl-rl-lib
 ```
 
 or by cloning this repository and installing it with:
@@ -40,7 +40,7 @@ For a demo configuration of PPO, please check the [dummy_config.yaml](config/dum
 
 ## Contribution Guidelines
 
-For documentation, we adopt the [Google Style Guide](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for docstrings. We use [Sphinx](https://www.sphinx-doc.org/en/master/) for generating the documentation. Please make sure that your code is well-documented and follows the guidelines.
+For documentation, we adopt the [Google Style Guide](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for docstrings. Please make sure that your code is well-documented and follows the guidelines.
 
 We use the following tools for maintaining code quality:
 
@@ -58,7 +58,7 @@ pre-commit install
 pre-commit run --all-files
 ```
 
-### Useful Links
+## Useful Links
 
 Environment repositories using the framework:
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rsl-rl-lib"
-version = "2.1.0"
+version = "2.1.1"
 maintainers = [
   { name="Clemens Schwarke", email="[email protected]" },
   { name="Mayank Mittal", email="[email protected]" },

diff --git a/rsl_rl/__init__.py b/rsl_rl/__init__.py
@@ -5,5 +5,5 @@
 
 """Main module for the rsl_rl package."""
 
-__version__ = "2.1.0"
+__version__ = "2.1.1"
 __license__ = "BSD-3"