Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Mar 6, 2021
1 parent a64a53b commit b3b90fb
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Expand Up @@ -10,6 +10,7 @@ in progress
- Store the image format for later reuse directly after reading the original image
- Run black and isort on the code base
- Improve dependencies
- Improve documentation


2020-06-08 0.3.0
Expand Down
30 changes: 22 additions & 8 deletions README.rst
@@ -1,11 +1,20 @@
.. image:: https://img.shields.io/badge/Python-3-green.svg
:target: https://github.com/panodata/imagecast
.. image:: https://github.com/panodata/imagecast/workflows/Tests/badge.svg
:target: https://github.com/panodata/imagecast/actions?workflow=Tests

.. image:: https://img.shields.io/pypi/pyversions/imagecast.svg
:target: https://python.org

.. image:: https://img.shields.io/pypi/v/imagecast.svg
:target: https://pypi.org/project/imagecast/

.. image:: https://img.shields.io/github/tag/panodata/imagecast.svg
:target: https://github.com/panodata/imagecast
.. image:: https://img.shields.io/pypi/status/imagecast.svg
:target: https://pypi.org/project/imagecast/

.. image:: https://img.shields.io/pypi/l/imagecast.svg
:target: https://pypi.org/project/imagecast/

.. image:: https://img.shields.io/pypi/dm/imagecast.svg
:target: https://pypi.org/project/imagecast/

|
Expand All @@ -19,11 +28,12 @@ Imagecast
*****
About
*****
Imagecast is like ImageMagick but for Pythonistas.
Optionally provides its features via HTTP API.

Currently, this is based on Pillow_. However, it
might be based on Wand_ in the future.
Imagecast is like ImageMagick but for Pythonistas. Optionally provides its
features via HTTP API.

Currently, this is based on Pillow_. However, it might be based on Wand_ in
the future.

There might still be dragons.

Expand All @@ -49,6 +59,7 @@ With service API::
********
Features
********

- Colorspace conversion: monochrome, grayscale
- Cropping with negative right/bottom offsets
- Resizing while keeping aspect ratio
Expand All @@ -59,6 +70,7 @@ Features
********
Synopsis
********

::

# Display on screen
Expand All @@ -78,6 +90,7 @@ Example::

HTTP API
========

Start the Imagecast service as daemon::

imagecast service
Expand All @@ -99,6 +112,7 @@ Example::
**************
Other projects
**************

- https://github.com/DictGet/ecce-homo
- https://github.com/agschwender/pilbox
- https://github.com/francescortiz/image
6 changes: 6 additions & 0 deletions setup.py
Expand Up @@ -12,6 +12,12 @@
license="AGPL 3, EUPL 1.2",
classifiers=[
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: Implementation :: CPython",
"License :: OSI Approved :: GNU Affero General Public License v3",
"License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)",
"Development Status :: 3 - Alpha",
Expand Down

0 comments on commit b3b90fb

Please sign in to comment.