Skip to content

Commit

Permalink
Prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
friedkeenan committed Jun 16, 2023
1 parent b72a802 commit 2a35cc2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 20 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Pak

<!-- TODO: Change repo URL and add Python version support badge. -->

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/friedkeenan/pak.py/ci.yml?label=checks)](https://github.com/friedkeenan/pak.py/commit/HEAD)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/friedkeenan/pak/ci.yml?label=checks)](https://github.com/friedkeenan/pak/commit/HEAD)
[![Read the Docs](https://img.shields.io/readthedocs/pak)](https://pak.readthedocs.io/)
[![Codecov](https://img.shields.io/codecov/c/github/friedkeenan/pak.py)](https://app.codecov.io/gh/friedkeenan/pak.py)
[![License](https://img.shields.io/github/license/friedkeenan/pak.py)](https://github.com/friedkeenan/pak.py/blob/main/LICENSE)
[![Codecov](https://img.shields.io/codecov/c/github/friedkeenan/pak)](https://app.codecov.io/gh/friedkeenan/pak)
[![License](https://img.shields.io/github/license/friedkeenan/pak)](https://github.com/friedkeenan/pak/blob/main/LICENSE)
[![Python Version Support](https://img.shields.io/pypi/pyversions/pak)](https://pypi.org/project/pak/)

Pak is a simple, yet powerful and extendable Python library for translating between raw data and usable, meaningful values.

Expand Down Expand Up @@ -62,10 +61,6 @@ assert packet_data == raw_data

To install Pak, simply install through pip:

> **Warning**
>
> This is not actually possible at the moment.
```
$ pip install pak
```
Expand Down
10 changes: 1 addition & 9 deletions docs/source/tutorials/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,7 @@ This document should introduce you to how to get started with Pak, giving you a
Installation
************

.. TODO: This may need to be changed to 'pak.py' depending on pypi.
To install Pak, simply install through pip:

.. attention::

This is not actually possible at the moment.

::
To install Pak, simply install through pip::

$ pip install pak

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "pak"
version = "0.1.0"
description = "A library for packet marshaling"
version = "1.0.0"
description = "A general purpose packet marshaling library"
readme = "README.md"
requires-python = ">=3.7"
license = {file = "LICENSE"}
Expand Down

0 comments on commit 2a35cc2

Please sign in to comment.