Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LucasAndradeDias authored Oct 5, 2023
1 parent 41ed409 commit 0ab5853
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Outliner (Under development)
# Outliner (Alpha)

The Outliner library is a Python tool that helps users trace and analyze complex objects, providing valuable insights and information about them. Whether you're dealing with intricate data structures or challenging scenarios, Outliner can assist you in gaining a clearer understanding.

Expand All @@ -20,16 +20,10 @@ The Outliner library is a Python tool that helps users trace and analyze complex
## Instalation
As the library hasn't been released yet, to use it on your machine, you will need to do following steps:

- **Clone the repository:**
```
git clone https://github.com/LucasAndradeDias/outliner.git path/you/want/to/save
cd path/you/want/to/save
```

- **Use pip install:**
Make sure that path contains the setup.py file
```
pip install .
pip install -i https://test.pypi.org/simple/ outliner
```

## Usage
Expand Down

0 comments on commit 0ab5853

Please sign in to comment.