feat: adding install help + description +

changing version
nephi-dev · Apr 26, 2023 · 5574703 · 5574703
1 parent 13ee680
commit 5574703
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rxml"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 
 [lib]

diff --git a/README.md b/README.md
@@ -4,6 +4,16 @@
 
 `rxml` is a simple python library to read xml files up to 2 times faster than python's `xml(ElementTree)` library.
 
+## Installation
+
+To install `rxml` you can use `pip`:
+
+```bash
+pip install rxml
+```
+
+Simply as that!
+
 ## Example usage
 
 To a given xml with `test.xml` as name:

diff --git a/pyproject.toml b/pyproject.toml
@@ -10,6 +10,7 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
+description = "A XML parser for Python written in Rust"
 
 
 [tool.maturin]