initial commit

1 files changed, 59 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e10029a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# NBA
+
+NBA is a simple Python package that provides you with a quick and easy
+command-line interface to current NBA scores and standings.
+
+See the Installation & Usage sections below for more information.
+
+# Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+
+# Installation
+
+[Back to top](#table-of-contents)
+
+## PyPi
+
+```shell
+bash pipx install nba-cli
+```
+
+## Manual
+
+To run the script locally, run the following commands:
+
+```shell
+git clone https://github.com/ccleberg/nba
+cd nba
+pipx install .
+```
+
+![Installation](https://github.com/ccleberg/nba/blob/main/examples/installation.png?raw=true)
+
+# Usage
+
+[Back to top](#table-of-contents)
+
+All commands can be passed to the program with the following template:
+`nba <ARGUMENT>`
+
+| Argument      | Shortcut | Description                       |
+|---------------|----------|-----------------------------------|
+| `--scores`    | `-sc`    | Show today's scoreboard           |
+| `--standings` | `-st`    | Show current conference standings |
+
+Scores:
+![Scores](https://github.com/ccleberg/nba/blob/main/examples/scores.png?raw=true)
+
+Standings:
+![Standings](https://github.com/ccleberg/nba/blob/main/examples/standings.png?raw=true)
+
+# Contributing
+
+[Back to top](#table-of-contents)
+
+Any and all contributions are welcome. Feel free to fork the project,
+add features, and submit a pull request.