add: mascot

metaist · Dec 15, 2023 · a347658 · a347658
1 parent fb4945e
commit a347658
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,20 @@
-# castfit
-
-_Basic type casting._
-
-[![Build Status](https://img.shields.io/github/actions/workflow/status/metaist/castfit/.github/workflows/ci.yaml?branch=main&style=for-the-badge)](https://github.com/metaist/castfit/actions)
-[![castfit on PyPI](https://img.shields.io/pypi/v/castfit.svg?color=blue&style=for-the-badge)](https://pypi.org/project/castfit)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/castfit?style=for-the-badge)](https://pypi.org/project/castfit)
-
-[Changelog] - [Issues] - [Documentation]
-
-[changelog]: https://github.com/metaist/castfit/blob/main/CHANGELOG.md
-[issues]: https://github.com/metaist/castfit/issues
-[documentation]: https://metaist.github.io/castfit/
+## castfit: basic type casting
+
+<p align="center">
+  <a href="https://metaist.github.io/castfit/"><img alt="castfit" width="200" src="https://raw.githubusercontent.com/metaist/castfit/main/cats-fit.png" /></a><br />
+  <em>Do you even castfit?<br />If it fits, I sits.</em>
+</p>
+<p align="center">
+  <a href="https://github.com/metaist/castfit/actions/workflows/ci.yaml"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/metaist/castfit/.github/workflows/ci.yaml?branch=main&logo=github"/></a>
+  <!-- <a href="https://github.com/metaist/castfit/issues"><img alt="Issues" src="https://img.shields.io/github/issues/metaist/castfit?logo=github"/></a> -->
+  <!-- <br /> -->
+  <a href="https://pypi.org/project/castfit"><img alt="PyPI" src="https://img.shields.io/pypi/v/castfit.svg?color=blue" /></a>
+  <a href="https://pypi.org/project/castfit"><img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/castfit" /></a>
+  <!-- <br />
+  <a href="https://metaist.github.io/castfit/"><img alt="Docs" src="https://img.shields.io/badge/docs-read-%2" /></a>
+  <a href="https://github.com/metaist/castfit/blob/main/CHANGELOG.md"><img alt="Changelog" src="https://img.shields.io/badge/changelog-read-%2"></a>
+  <a href="https://github.com/metaist/castfit/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/metaist/castfit" /></a> -->
+</p>
 
 ## Why?
 

diff --git a/cats-fit.png b/cats-fit.png
diff --git a/docs/index.html b/docs/index.html
@@ -5,7 +5,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>castfit API documentation</title>
-<meta name="description" content="Basic type casting …" />
+<meta name="description" content="castfit: basic type casting …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,11 +22,22 @@
 <h1 class="title">Package <code>castfit</code></h1>
 </header>
 <section id="section-intro">
-<p>Basic type casting.</p>
-<p><a href="https://github.com/metaist/castfit/actions"><img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/metaist/castfit/.github/workflows/ci.yaml?branch=main&amp;style=for-the-badge"></a>
-<a href="https://pypi.org/project/castfit"><img alt="castfit on PyPI" src="https://img.shields.io/pypi/v/castfit.svg?color=blue&amp;style=for-the-badge"></a>
-<a href="https://pypi.org/project/castfit"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/castfit?style=for-the-badge"></a></p>
-<p><a href="https://github.com/metaist/castfit/blob/main/CHANGELOG.md">Changelog</a> - <a href="https://github.com/metaist/castfit/issues">Issues</a> - <a href="https://metaist.github.io/castfit/">Documentation</a></p>
+<p>castfit: basic type casting</p>
+<p align="center">
+<a href="https://metaist.github.io/castfit/"><img alt="castfit" width="200" src="https://raw.githubusercontent.com/metaist/castfit/main/cats-fit.png" /></a><br />
+<em>Do you even castfit?<br />If it fits, I sits.</em>
+</p>
+<p align="center">
+<a href="https://github.com/metaist/castfit/actions/workflows/ci.yaml"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/metaist/castfit/.github/workflows/ci.yaml?branch=main&logo=github"/></a>
+<!-- <a href="https://github.com/metaist/castfit/issues"><img alt="Issues" src="https://img.shields.io/github/issues/metaist/castfit?logo=github"/></a> -->
+<!-- <br /> -->
+<a href="https://pypi.org/project/castfit"><img alt="PyPI" src="https://img.shields.io/pypi/v/castfit.svg?color=blue" /></a>
+<a href="https://pypi.org/project/castfit"><img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/castfit" /></a>
+<!-- <br />
+<a href="https://metaist.github.io/castfit/"><img alt="Docs" src="https://img.shields.io/badge/docs-read-%2" /></a>
+<a href="https://github.com/metaist/castfit/blob/main/CHANGELOG.md"><img alt="Changelog" src="https://img.shields.io/badge/changelog-read-%2"></a>
+<a href="https://github.com/metaist/castfit/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/metaist/castfit" /></a> -->
+</p>
 <h2 id="why">Why?</h2>
 <p>I'm writing more and more type-checked code, but I often get a bunch of strings I need to convert (e.g., from <a href="https://github.com/docopt/docopt"><code>docopt</code></a>).</p>
 <ul>
@@ -59,10 +70,10 @@ <h2 id="license">License</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">&#34;&#34;&#34;Basic type casting.
+<pre><code class="python">&#34;&#34;&#34;castfit: basic type casting
 
 .. include:: ../../README.md
-   :start-line: 4
+   :start-line: 2
 &#34;&#34;&#34;
 
 # std

diff --git a/src/castfit/__init__.py b/src/castfit/__init__.py
@@ -1,7 +1,7 @@
-"""Basic type casting.
+"""castfit: basic type casting
 
 .. include:: ../../README.md
-   :start-line: 4
+   :start-line: 2
 """
 
 # std