Skip to content

Commit 8d4ee49

Browse files
committed
Add pip installation and development guide to README
1 parent baffc95 commit 8d4ee49

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
> A python package that gets stocks prices from [yahoo finance](https://finance.yahoo.com/) and calculates how much of each stocks you must buy to have almost equal distribution between the stocks you want in your portfolio
77
8-
## ** Disclaimer **
8+
## \*\*\*Disclaimer\*\*\*
99

1010
**NO FINANCIAL ADVISE** - This library **DO NOT** offer financial advises, it just calculates the amount of stocks you will need to buy based on stocks that **YOU WILL INFORM** and the market price of the day for these stocks, given by [yahoo finance](https://finance.yahoo.com/).
1111

@@ -15,16 +15,10 @@
1515

1616
## Install
1717

18-
- clone the repository
18+
- install via pip
1919

2020
```sh
21-
git clone [email protected]:capaci/allokation.git
22-
```
23-
24-
- install dependencies
25-
26-
```sh
27-
pip install -r requirements.txt
21+
pip install allokation
2822
```
2923

3024
## Usage
@@ -75,7 +69,24 @@ pip install -r requirements.txt
7569

7670
Check out the example available in [`example/example.py`](./example/example.py) to see it in action.
7771

78-
## Run tests
72+
## Development Guide
73+
74+
### Getting the project
75+
76+
- clone this repository
77+
78+
```sh
79+
git clone [email protected]:capaci/allokation.git
80+
```
81+
82+
- install dependencies
83+
84+
```sh
85+
pip install -r requirements.txt
86+
pip install -r requirements-tests.txt
87+
```
88+
89+
### Run tests
7990

8091
- Unit tests
8192

0 commit comments

Comments
 (0)