Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ShineyDev committed Jan 30, 2024
1 parent 95244a0 commit dd2b367
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
.. raw:: html

<p align="center">
<a href="https://github.com/ShineyDev/screen/actions?query=workflow%3AAnalyze">
<img alt="Analyze Status" src="https://github.com/ShineyDev/screen/workflows/Analyze/badge.svg?event=push" />
<a href="https://github.com/ShineyDev/screen/actions/workflows/analyze.yml?query=branch%3Amain+event%3Apush+is%3Acompleted">
<img alt="Analyze Status" src="https://github.com/ShineyDev/screen/actions/workflows/analyze.yml/badge.svg?branch=main&event=push" />
</a>

<a href="https://github.com/ShineyDev/screen/actions?query=workflow%3ABuild">
<img alt="Build Status" src="https://github.com/ShineyDev/screen/workflows/Build/badge.svg?event=push" />
<a href="https://github.com/ShineyDev/screen/actions/workflows/build.yml?query=branch%3Amain+event%3Apush+is%3Acompleted">
<img alt="Build Status" src="https://github.com/ShineyDev/screen/actions/workflows/build.yml/badge.svg?branch=main&event=push" />
</a>

<a href="https://github.com/ShineyDev/screen/actions?query=workflow%3ACheck">
<img alt="Check Status" src="https://github.com/ShineyDev/screen/workflows/Check/badge.svg?event=push" />
<a href="https://github.com/ShineyDev/screen/actions/workflows/check.yml?query=branch%3Amain+event%3Apush+is%3Acompleted">
<img alt="Check Status" src="https://github.com/ShineyDev/screen/actions/workflows/check.yml/badge.svg?branch=main&event=push" />
</a>

<a href="https://github.com/ShineyDev/screen/actions?query=workflow%3ADeploy">
<img alt="Deploy Status" src="https://github.com/ShineyDev/screen/workflows/Deploy/badge.svg?event=push" />
<a href="https://github.com/ShineyDev/screen/actions/workflows/deploy.yml?query=branch%3Amain+event%3Apush+is%3Acompleted">
<img alt="Deploy Status" src="https://github.com/ShineyDev/screen/actions/workflows/deploy.yml/badge.svg?branch=main&event=push" />
</a>

<a href="https://github.com/ShineyDev/screen/actions?query=workflow%3ALint">
<img alt="Lint Status" src="https://github.com/ShineyDev/screen/workflows/Lint/badge.svg?event=push" />
<a href="https://github.com/ShineyDev/screen/actions/workflows/lint.yml?query=branch%3Amain+event%3Apush+is%3Acompleted">
<img alt="Lint Status" src="https://github.com/ShineyDev/screen/actions/workflows/lint.yml/badge.svg?branch=main&event=push" />
</a>
</p>

Expand All @@ -27,24 +27,23 @@
.. raw:: html

<h1 align="center">ShineyDev/screen</h1>
<p align="center">A Python library for creating TUI inspired by WPF.<br><a href="https://docs.shiney.dev/screen">documentation</a> | <a href="https://github.com/ShineyDev/screen/tree/main/examples">examples</a></p>
<p align="center">A Python library for creating TUI inspired by WPF.<br><a href="https://github.com/ShineyDev/screen">source</a> | <a href="https://docs.shiney.dev/screen">documentation</a></p>


Install
-------

.. code:: shell
$ pip install --upgrade git+https://github.com/ShineyDev/screen.git@main
$ python -m pip install --upgrade git+https://github.com/ShineyDev/screen.git@main
.. Use
---
Use
---

.. code:: python
.. code:: python
>>> import screen
>>> # TODO
TODO
.. raw:: html
Expand Down

0 comments on commit dd2b367

Please sign in to comment.