Skip to content

Commit fca2516

Browse files
author
Vivek Dagar
authored
Update README.md
1 parent dad4ce0 commit fca2516

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ Pyquantify is a powerful CLI tool for semantic analysis. It leverages natural la
1212

1313
[![Python 3](https://img.shields.io/badge/Python-3-brightgreen)](https://www.python.org/)
1414

15+
## Table Of Contents
16+
* [Features](#features)
17+
* [Installation](#installation)
18+
- [Install pyquantify with pip](#install-pyquantify-with-pip)
19+
- [or you can build locally](#or-you-can-build-locally)
20+
* [Before running pyquantify](#before-running-pyquantify)
21+
* [Usage/Examples](#usageexamples)
22+
* [FAQ](#faq)
23+
* [Screenshots](#screenshots)
24+
* [Acknowledgements](#acknowledgements)
25+
26+
1527
## Demo
1628

1729
<img src="https://github.com/vivekkdagar/pyquantify/blob/main/assets/screenshots/menu.png">
@@ -189,8 +201,8 @@ pyquantify git
189201
pyquantify keywords --mode [raw/file/website] --export
190202
```
191203

192-
1. --mode: Specify the data loading mode (raw input, file, or website).
193-
2. --export: Optional flag to export the extracted keywords to a file.
204+
- `--mode`: Specify the data loading mode (raw input, file, or website).
205+
- `--export`: Optional flag to export the extracted keywords to a file.
194206

195207

196208
9. **Calculate Cosine Similarity:**
@@ -234,8 +246,6 @@ NLPFreq felt limiting and didn't capture the full scope of the project. Pyquanti
234246

235247
## Acknowledgements
236248

237-
- [Awesome Readme Templates](https://awesomeopensource.com/project/elangosundar/awesome-README-templates)
238-
- [Awesome README](https://github.com/matiassingers/awesome-readme)
239-
- [How to write a Good readme](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project)
240-
241249
- [NeuralNine's Publish Your Own Python Package](https://www.youtube.com/watch?v=tEFkHEKypLI)
250+
- [Github Readme Generator](https://readme.so/)
251+
- [Table of Content Generator](https://derlin.github.io/bitdowntoc/)

0 commit comments

Comments
 (0)