Skip to content

Commit

Permalink
[README] add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
autumnjolitz committed Dec 5, 2023
1 parent 4431408 commit b30a7bc
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: On release
name: Release

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Test library
name: Tests

on:
push:
Expand Down
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Instruct
==========

|Release|
|Style|
|PyPI|



A compact, fast object system that can serve as the basis for a DAO model.

To that end, instruct uses ``__slots__`` to prevent new attribute addition, properties to control types, event listeners and historical changes, and a Jinja2-driven codegen to keep a pure-Python implementation as fast and as light as possible.
Expand Down Expand Up @@ -422,3 +428,12 @@ After additions of those. Safety is expensive.
Overhead of clearing/setting
Test with safeties: 1.29 us
Test without safeties: 1.14 us
.. |PyPI| image:: https://img.shields.io/pypi/v/instruct.svg
:target: https://pypi.python.org/pypi/instruct
.. |Release| image:: https://github.com/autumnjolitz/instruct/actions/workflows/release.yml/badge.svg
:target: https://github.com/autumnjolitz/instruct/actions/workflows/release.yml
.. |Style| image:: https://github.com/autumnjolitz/instruct/actions/workflows/style-check.yml/badge.svg
:target: https://github.com/autumnjolitz/instruct/actions/workflows/style-check.yml

0 comments on commit b30a7bc

Please sign in to comment.