diff --git a/README.md b/README.md index 6173674..d06352b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# Txt-File-Analyser -A simple text analyser +## Xameren text file analyser +A simple text analyser made in python as a CLI application. +![An image of the analyser's CLI](https://github.com/Xameren/Txt-File-Analyser/blob/main/Screenshot%20of%20the%20analyser.png) +## Installation and Requirements +To use this tool, you will need to have Python installed on your machine. + +### Prerequisites +- [Python](https://www.python.org/downloads/) + +### Installation +Clone the repository: +`git clone https://github.com/Xameren/Txt-File-Analyser.git` + +Navigate to the project directory: +`cd Txt-File-Analyser` + +Run the Python file: +`python Text analyzer.py` + +## Licence +The analyzer is currently under the [MIT Licence](LICENSE)