Skip to content

Commit cf7950d

Browse files
authored
Clean up readme (#1000)
1 parent daf9102 commit cf7950d

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

Diff for: README.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
<p align="center" id="reactpy">
2-
<a href="#">
3-
<img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-landscape.svg" alt="ReactPy Logo" style="min-width: 300px; width: 50%" />
4-
</a>
5-
</p>
6-
<p align="center">
7-
<em>Reactive user interfaces with pure Python</em>
8-
</p>
9-
<p align="center">
1+
# <img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg" align="left" height="45"/> ReactPy
2+
3+
<p>
104
<a href="https://github.com/reactive-python/reactpy/actions">
11-
<img src="https://github.com/reactive-python/reactpy/workflows/test/badge.svg" alt="Build Status">
5+
<img src="https://github.com/reactive-python/reactpy/workflows/test/badge.svg?event=push">
126
</a>
137
<a href="https://pypi.org/project/reactpy/">
14-
<img src="https://badge.fury.io/py/reactpy.svg" alt="Package version">
8+
<img src="https://img.shields.io/pypi/v/reactpy.svg?label=PyPI">
9+
</a>
10+
<a href="https://github.com/reactive-python/reactpy/blob/main/LICENSE">
11+
<img src="https://img.shields.io/badge/License-MIT-purple.svg">
12+
</a>
13+
<a href="https://reactpy.dev/">
14+
<img src="https://img.shields.io/website?down_message=offline&label=Docs&logo=read-the-docs&logoColor=white&up_message=online&url=https%3A%2F%2Freactpy.dev%2Fdocs%2Findex.html">
15+
</a>
16+
<a href="https://discord.gg/uNb5P4hA9X">
17+
<img src="https://img.shields.io/discord/1111078259854168116?label=Discord&logo=discord">
1518
</a>
1619
</p>
1720

1821
---
1922

20-
[ReactPy](https://reactpy.dev/) is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components which look and behave similarly to those found in [ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used by those without web development experience while also being powerful enough to grow with your ambitions.
23+
[ReactPy](https://reactpy.dev/) is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components that look and behave similar to those found in [ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used by those without web development experience while also being powerful enough to grow with your ambitions.
2124

2225
<table align="center">
2326
<thead>
@@ -38,7 +41,7 @@
3841
<td>
3942
<a href="https://github.com/reactive-python/reactpy-django">Django</a>,
4043
<a href="https://github.com/reactive-python/reactpy-jupyter">Jupyter</a>,
41-
<a href="https://github.com/reactive-python/reactpy-dash">Plotly-Dash</a>
44+
<a href="https://github.com/idom-team/idom-dash">Plotly-Dash</a>
4245
</td>
4346
</tr>
4447
</tbody>
@@ -52,18 +55,19 @@ To get a rough idea of how to write apps in ReactPy, take a look at this tiny _H
5255
from reactpy import component, html, run
5356

5457
@component
55-
def HelloWorld():
58+
def hello_world():
5659
return html.h1("Hello, World!")
5760

58-
run(HelloWorld)
61+
run(hello_world)
5962
```
6063

6164
# Resources
6265

6366
Follow the links below to find out more about this project.
6467

65-
- [Try it Now](https://mybinder.org/v2/gh/reactive-python/reactpy-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out ReactPy in a Jupyter Notebook.
66-
- [Documentation](https://reactpy.dev/) - learn how to install, run, and use ReactPy.
67-
- [Community Forum](https://github.com/reactive-python/reactpy/discussions) - ask questions, share ideas, and show off projects.
68-
- [Contributor Guide](https://reactpy.dev/docs/developing-reactpy/contributor-guide.html) - see how you can help develop this project.
69-
- [Code of Conduct](https://github.com/reactive-python/reactpy/blob/main/CODE_OF_CONDUCT.md) - standards for interacting with this community.
68+
- [Try ReactPy (Jupyter Notebook)](https://mybinder.org/v2/gh/reactive-python/reactpy-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb)
69+
- [Documentation](https://reactpy.dev/)
70+
- [GitHub Discussions](https://github.com/reactive-python/reactpy/discussions)
71+
- [Discord](https://discord.gg/uNb5P4hA9X)
72+
- [Contributor Guide](https://reactpy.dev/docs/developing-reactpy/contributor-guide.html)
73+
- [Code of Conduct](https://github.com/reactive-python/reactpy/blob/main/CODE_OF_CONDUCT.md)

0 commit comments

Comments
 (0)