aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 3657d40fb534a8e5c121af299ce4bdd1977c7950 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
senpy-rs
========

A wrapper of The Senpy Club API, which is a wrapper of the
`cat-milk/Anime-Girls-Holding-Programming-Books <https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books>`_
repository.

Quick links
^^^^^^^^^^^

.. raw:: html

  <p>
    <a href="https://discord.com/invite/yWKgRT6">
      <img src="https://img.shields.io/discord/246524734718738442"
           alt="Discord" />
    </a>
    <a href="https://www.codefactor.io/repository/github/senpy-club/senpy-rs">
      <img src="https://www.codefactor.io/repository/github/senpy-club/senpy-rs/badge"
           alt="CodeFactor" />
    </a>
    <a href="https://saythanks.io/to/[email protected]">
      <img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg"
           alt="Say Thanks" />
    </a>
    <a href="LICENSE">
      <img src="https://img.shields.io/github/license/senpy-club/senpy-rs"
           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
-----

.. code-block:: toml

  # Cargo.toml

  [dependencies]
  senpy = "0.1.2"

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-rs/blob/main/LICENSE>`_