Skip to content

Commit e994b71

Browse files
authored
Update README.md
1 parent aa5b5e1 commit e994b71

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
11
# Django IDOM
22

3-
Support for IDOM in Django
3+
<a href="https://github.com/idom-team/django-idom/actions?query=workflow%3ATest">
4+
<img alt="Tests" src="https://github.com/idom-team/django-idom/workflows/Test/badge.svg?event=push" />
5+
</a>
6+
<a href="https://pypi.python.org/pypi/django-idom">
7+
<img alt="Version Info" src="https://img.shields.io/pypi/v/idom.svg"/>
8+
</a>
9+
<a href="https://github.com/idom-team/django-idom/blob/main/LICENSE">
10+
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-purple.svg">
11+
</a>
12+
13+
A package for building highly interactive user interfaces in pure Python inspred by
14+
[ReactJS](https://reactjs.org/).
15+
16+
**Be sure to [read the IDOM Documentation](https://idom-docs.herokuapp.com)!**
17+
18+
If you have ideas or find a bug, be sure to post an
19+
[issue](https://github.com/idom-team/django-idom/issues)
20+
or create a
21+
[pull request](https://github.com/idom-team/django-idom/pulls). Thanks in advance!
22+
23+
<h3>
24+
<a
25+
target="_blank"
26+
href="https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?filepath=notebooks%2Fintroduction.ipynb"
27+
>
28+
Try it Now
29+
<img alt="Binder" valign="bottom" height="25px"
30+
src="https://mybinder.org/badge_logo.svg"
31+
/>
32+
</a>
33+
</h3>
34+
35+
Click the badge above to get started! It will take you to a [Jupyter Notebooks](https://jupyter.org/)
36+
hosted by [Binder](https://mybinder.org/) with some great examples.
37+
38+
### Or Install it Now
39+
40+
```bash
41+
pip install django-idom
42+
```
43+
44+
# Django Integration
45+
46+
This version of IDOM can be directly integrated into Django. For example
47+
48+
```python
49+
# Example code goes here
50+
```
51+
52+
For examples on how to use IDOM, [read the IDOM Documentation](https://idom-docs.herokuapp.com).

0 commit comments

Comments
 (0)