Skip to content

Commit c726cfc

Browse files
authored
Create README.rst
1 parent 13ad6ea commit c726cfc

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

profile/README.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. image:: UltraPlotLogo.svg
2+
:width: 100%
3+
4+
|build-status| |docs| |pypi| |code-style| |pr-welcome| |license|
5+
6+
Hi there!
7+
8+
Welcome to UltraPlot, a succint wrapper to matplotlib for producing beautiful plots.
9+
10+
Why Code More When You Can Code Less?
11+
=====================================
12+
It's UltraPlots mission to make plotting as easy as possible. We believe that the less code you have to write, create or design intricate plots. We do this by expanding the workhorse of scientific plotting -- matplotlib -- and set sensible defaults to produce beautiful plots. Furthermore, we modify the syntax to make plotting complicated plots are breeze. This way, you can focus on the data and the story you want to tell.
13+
14+
Have a look around and explore our docs_.
15+
16+
.. _docs: https://readthedocs.org/projects/ultraplot/badge/?version=latest
17+
18+
Installation
19+
============
20+
21+
.. code-block:: bash
22+
23+
pip install ultraplot
24+
conda install ultraplot
25+
26+
*It's that simple!*
27+
28+
29+
.. |build-status| image:: https://github.com/ultraplot/ultraplot/actions/workflows/build-ultraplot.yml/badge.svg
30+
31+
.. |code-style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
32+
33+
.. |pr-welcome| image:: https://img.shields.io/badge/PRs-welcome-brightgreen
34+
35+
.. |docs| image:: https://readthedocs.org/projects/ultraplot/badge/?version=latest
36+
:alt: docs
37+
:target: https://ultraplot.readthedocs.io/en/latest/?badge=latest
38+
39+
.. |pypi| image:: https://img.shields.io/pypi/v/ultraplot?color=83%20197%2052
40+
:alt: pypi
41+
:target: https://pypi.org/project/ultraplot/
42+
43+
.. |license| image:: https://img.shields.io/github/license/ultraplot/ultraplot.svg
44+
:alt: license
45+
:target: LICENSE.txt

0 commit comments

Comments
 (0)