diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a3ee393 --- /dev/null +++ b/README.rst @@ -0,0 +1,55 @@ +senpy-ffi +========= + +FFI bindings for `senpy-rs <https://github.com/senpy-club/senpy-rs>`_ + +Notice +------ + +More FFI examples to come. + +Quick links +^^^^^^^^^^^ + +.. raw:: html + + <p> + <a href="LICENSE"> + <img src="https://img.shields.io/github/license/senpy-club/senpy-ffi" + alt="License" /> + </a> + <a href="https://crates.io/crates/senpy"> + <img src="https://img.shields.io/crates/v/senpy.svg" + alt="Crate" /> + </a> + <a href="https://docs.rs/senpy"> + <img src="https://docs.rs/senpy/badge.svg" + alt="Documentation" /> + </a> + <a href="https://github.com/senpy-club/api-worker/actions/workflows/check.yaml"> + <img src="https://github.com/senpy-club/api-worker/actions/workflows/check.yaml/badge.svg?branch=main" + alt="Build Status" /> + </a> + </p> + +Usage Examples +-------------- + +.. code-block:: shell + + $ python3 examples/ffi.py + $ luvit examples/ffi.lua + $ perl examples/ffi.pl + $ php examples/ffi.php + +Examples +-------- + +.. raw:: html + + Examples can be found within the <a href="./examples"><code>examples/</code></a> directory. + +License +^^^^^^^ + +`GNU General Public License v3.0 <https://github.com/senpy-club/senpy-ffi/blob/main/LICENSE>`_ |