Skip to content

Commit 3242da6

Browse files
Archmongerrmorshea
andauthored
Readme Overhaul (#705)
* Update readme summary * minor verbiage changes * Move supported frameworks to a new line * plotly-dash * Reorder plotly to prevent text cutoff * wordsmithing * wordsmithing 2 * remove "composing" verbiage * minor clarification * Update README.md Co-authored-by: Ryan Morshead <[email protected]> * wordsmithing * reduced verbosity * within -> in * fix hyperlink location * Remove accidental auto-format * ecosystem independance shortening * backed -> based * it's always wordsmithing * shortening some stuff * split sections * python framework * wordsmitherererest * more human sounding ecosystem indepedence paragraph * smithy * requested changes * more words Co-authored-by: Ryan Morshead <[email protected]>
1 parent c7be65e commit 3242da6

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
# IDOM &middot; [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE)
22

3-
IDOM is a Python web framework for building **interactive websites without needing a
4-
single line of Javascript**. These sites are built from small elements of functionality
5-
like buttons text and images. IDOM allows you to combine these elements into reusable
6-
"components" that can be composed together to create complex views.
7-
8-
Ecosystem independence is also a core feature of IDOM. It can be added to existing
9-
applications built on a variety of sync and async web servers, as well as integrated
10-
with other frameworks like Django, Jupyter, and Plotly Dash. Not only does this mean
11-
you're free to choose what technology stack to run on, but on top of that, you can run
12-
the exact same components wherever you need them. For example, you can take a component
13-
originally developed in a Jupyter Notebook and embed it in your production application
14-
without changing anything about the component itself.
3+
IDOM is a Python micro-framework that links your web framework of choice to a ReactJS frontend, allowing you to create **interactive websites without needing JavaScript!**
4+
5+
Following ReactJS styling, web elements are combined into [reusable "components"](https://idom-docs.herokuapp.com/docs/guides/creating-interfaces/your-first-components/index.html#parametrizing-components). These components can utilize [hooks](https://idom-docs.herokuapp.com/docs/reference/hooks-api.html) and [events](https://idom-docs.herokuapp.com/docs/guides/adding-interactivity/responding-to-events/index.html#async-event-handlers) to create infinitely complex web pages.
6+
7+
When needed, IDOM can [use JavaScript components](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#dynamically-loaded-components) directly from NPM. Components can also be [developed in JavaScript](https://idom-docs.herokuapp.com/docs/guides/escape-hatches/javascript-components.html#custom-javascript-components) for additional flexibility.
8+
9+
IDOM's ecosystem independent design allows components to be reused across a variety of web frameworks. Pre-existing support is included for many popular Python frameworks, however, any framework with WebSocket support can be adapted to utilize IDOM.
10+
11+
| Supported Frameworks | Supported Frameworks (External) |
12+
| --- | --- |
13+
| [`Flask`, `FastAPI`, `Sanic`, `Tornado`](https://idom-docs.herokuapp.com/docs/guides/getting-started/installing-idom.html#officially-supported-servers) | [`Django`](https://github.com/idom-team/django-idom), [`Plotly-Dash`](https://github.com/idom-team/idom-dash), [`Jupyter`](https://github.com/idom-team/idom-jupyter) |
14+
1515

1616
# At a Glance
1717

18-
To get a rough idea of how to write apps in IDOM, take a look at the tiny "hello
19-
world" application below:
18+
To get a rough idea of how to write apps in IDOM, take a look at this tiny _Hello World_ application.
2019

2120
```python
2221
from idom import component, html, run
@@ -30,7 +29,7 @@ run(App)
3029

3130
# Resources
3231

33-
Follow the links below to find out more about this project
32+
Follow the links below to find out more about this project.
3433

3534
- [Try it Now](https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb) - check out IDOM in a Jupyter Notebook.
3635
- [Documentation](https://idom-docs.herokuapp.com/) - learn how to install, run, and use IDOM.

0 commit comments

Comments
 (0)