Skip to content

Commit 3c34455

Browse files
authored
Merge pull request #126 from mts310/docs/iterate_readme
[Doc] Fixing typos and broken links in README.md (#122)
2 parents 9b71a89 + 6407c06 commit 3c34455

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,21 @@ Python version of the TerminusDB client - for TerminusDB API and WOQLpy
88

99
## Requirements
1010
- [TerminusDB 2.0.5](https://github.com/terminusdb/terminusdb-server)
11-
- [Python >= 3.6]
11+
- Python >= 3.6
1212

13-
## Previous Versions
13+
## Release Notes and Previous Versions
14+
15+
- Please check [RELEASE_NOTES.md](RELEASE_NOTES.md) to find out what has changed.
1416

1517
These previous version(s) works with these version(s) of TerminusDB:
1618

1719
- 0.1.5 - works with TerminusDB server / console v2.0.4
1820

1921
## Installation
20-
- TerminusDB Client can be download form PyPI using pip:
22+
- TerminusDB Client can be downloaded form PyPI using pip:
2123
`python -m pip install terminusdb-client`
2224

23-
this only include the core Python Client (WOQLClient) and WOQLQuery.
25+
This only includes the core Python Client (WOQLClient) and WOQLQuery.
2426

2527
If you want to use woqlDataframe:
2628

@@ -35,10 +37,10 @@ If you want to use woqlDataframe:
3537
`python -m pip install git+https://github.com/terminusdb/terminusdb-client-python.git`
3638

3739
## Usage
38-
For the [full Documentation](https://terminusdb.github.io/terminusdb-client-python/)
40+
Please check the [full Documentation](https://terminusdb.github.io/terminusdb-client-python/)
3941

4042
## Tutorials
41-
Visit [terminus-tutorials](https://github.com/terminusdb/terminusdb-tutorials) for tutorial scripts and [Create TerminusDB Graph with Python Client](https://terminusdb.com/docs/getting-started/start-tutorials/py_client/) for a python-specific one.
43+
Visit [terminus-tutorials](https://github.com/terminusdb/terminus-tutorials/tree/master/bike-tutorial/python) for tutorial scripts and [Create TerminusDB Graph with Python Client](https://terminusdb.com/docs/getting-started/start-tutorials/py_client/) for a python-specific one.
4244

4345
## Testing
4446

@@ -64,7 +66,7 @@ $ tox
6466

6567
Documentation on the latest version can be found [here](https://terminusdb.github.io/terminusdb-client-python/).
6668

67-
### generating documentation locally
69+
### Generating Documentation Locally
6870

6971
1. Clone this repository
7072
`git clone https://github.com/terminusdb/terminusdb-client-python.git`
@@ -88,13 +90,13 @@ The output files are under `docs/build/html`, open `index.html` in your browser
8890

8991
## Report Issues
9092

91-
If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
93+
If you encounter any issues, please report them with your os and environment setup, the version that you are using and a simple reproducible case.
9294

93-
If you encounter other questions, you can ask in our community [forum](https://community.terminusdb.com/) or [Discord](https://discord.gg/Gvdqw97).
95+
If you have other questions, you can ask in our community [forum](https://community.terminusdb.com/) or [Discord](https://discord.gg/Gvdqw97).
9496

9597
## Contribute
9698

97-
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
99+
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add some test(s) of what value you adding.
98100

99101
Please check [Contributing.md](Contributing.md) for more information.
100102

0 commit comments

Comments
 (0)