diff --git a/README.md b/README.md index f57e078..01c09ef 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,69 @@ # render50 -## Usage +`render50` is a command-line tool from CS50 that renders and previews code or text files in a standardized, user-friendly format. + +--- + +## Installation + +Install via `pip`: +```bash +pip3 install render50 ``` -pip3 install cli50 -cli50 + +Or install locally from source: + +```bash +git clone https://github.com/cs50/render50 +cd render50 pip3 install -e . -./render50 ``` + +--- + +## Usage + +```bash +render50 [options] file [file ...] +``` + +### Example + +```bash +render50 example.txt +``` + +Replace `example.txt` with the path to your file. Multiple files may be passed as arguments. + +--- + +## Requirements + +* Python 3.x +* Dependencies listed in `requirements.txt` + +--- + +## Documentation + +Full documentation is available at: + +[https://cs50.readthedocs.io/render50/](https://cs50.readthedocs.io/render50/) + +--- + +## Contributing + +Contributions are welcome. Feel free to: + +* Open issues +* Submit pull requests +* Propose new features + +--- + +## License + +This project is licensed under the GPL-3.0 License. +