Skip to content

Commit 562dbd9

Browse files
authored
Merge pull request #6 from Ashan1/master
Readme updated
2 parents ec51c85 + ab2e5b8 commit 562dbd9

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,27 @@ Python scripts
55
66
---
77

8-
About
8+
# Table of contents
9+
1. [About] (#about)
10+
2. [Demo] (#demo)
11+
3. [Features] (#features)
12+
4. [Installation] (#installation)
13+
5. [Usage] (#usage)
14+
6. [Development] (#development)
15+
7. [Change log] (#change-log)
16+
8. [License] (#license)
17+
9. [Credits] (#credits)
18+
10. [Authors] (#authors)
19+
20+
## About
921
-----
1022

1123
Some python scripts to do some tasks:
1224

1325
- [acoes.py](https://github.com/ggrigon/python/blob/master/acoes.py): Command Line Tool that scrapes any brazilian stock price from [UOL website](http://cotacoes.economia.uol.com.br).
1426
- [cartola.py](https://github.com/ggrigon/python/blob/master/cartola.py): a bot to send Telegram messages about [Cartola-FC](http://globoesporte.globo.com/cartola-fc).
1527

16-
Demo
28+
## Demo
1729
----
1830

1931
See `acoes.py` in action:
@@ -24,7 +36,7 @@ See `cartola.py` in action:
2436

2537
<a href="./cartola.py"><img src="go.png" alt="Go" style="width: 50px; height: 50px"/></a>
2638

27-
Features
39+
## Features
2840
--------
2941

3042
There are some pros in this repository:
@@ -35,7 +47,7 @@ There are some pros in this repository:
3547

3648
Maybe we have more :)
3749

38-
Installation
50+
## Installation
3951
------------
4052

4153
### Requirements
@@ -62,7 +74,7 @@ In four steps:
6274
3. Open the folder in a terminal (shell);
6375
4. Run any commands showed in next section.
6476

65-
Usage
77+
## Usage
6678
-----
6779

6880
Open the Terminal (shell) and, go to the project folder that contains the script to be executed.
@@ -104,7 +116,7 @@ To run [cartola.py](https://github.com/ggrigon/python/blob/master/cartola.py):
104116

105117
*(blank)*
106118

107-
Development
119+
## Development
108120
-----------
109121

110122
### Contribution
@@ -119,7 +131,7 @@ Its simple!
119131

120132
Nothing! We have not any test classes. :(
121133

122-
Change log
134+
## Change log
123135
----------
124136

125137
All notable changes to this project will be documented in this file.
@@ -160,12 +172,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
160172

161173
- Included `acoes.py` file.
162174

163-
License
175+
## License
164176
-------
165177

166178
This project, named *Python*, is avaliable under the following license: [licence_name](http://www.example.org).
167179

168-
Credits
180+
## Credits
169181
-------
170182

171183
Acknowledgment to the following people and projects:
@@ -176,7 +188,7 @@ Acknowledgment to the following people and projects:
176188

177189
Thanks to everyone!
178190

179-
Authors
191+
## Authors
180192
-------
181193

182194
This project is authored by:

0 commit comments

Comments
 (0)