Skip to content

Commit

Permalink
meta: updated readme
Browse files Browse the repository at this point in the history
- Updated readme and pyproject.toml for pypi release
  • Loading branch information
moonburnt committed Nov 14, 2021
1 parent c88a8ce commit f75e4dc
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 13 deletions.
13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,6 @@
**HSCP** is a [HyScores](https://github.com/0x5b/hyscores) Client, written in
Python. Its designed to be a simple and efficient library to use in your games.

## Installation:

This project require [poetry](https://python-poetry.org/) to install.
After cloning project locally, run:

```
# Do it once to create .venv inside project directory
poetry config virtualenvs.in-project true
# Install deps, dev deps and project itself (in editable way)
poetry install
```

## Usage:

```python3
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description = "Client library for HyScores."
authors = ["moonburnt <moonburnt@disroot.org>"]
license = "MIT"
readme = "README.md"
homepage = "https://github.com/moonburnt/hscp"

[tool.poetry.dependencies]
python = "^3.9"
Expand Down

0 comments on commit f75e4dc

Please sign in to comment.