Skip to content

Commit c83966c

Browse files
Add docs badge and links to README (#192)
* Add docs badge and links to README The documentation is now live at https://fork-tongue.github.io/collagraph/ so link to it from the README: a Docs workflow badge next to the PyPI and CI badges, plus links in the intro and examples sections. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Update README counter example to text interpolation Match examples/pyside/counter.cgx and the documentation, which use text content with interpolation instead of the :text attribute. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Remove outdated mention of plain render functions from README Since the fine-grained reactivity overhaul, single-file components (.cgx) are the ergonomic way to write components, so describe that as the way to write interfaces and mention that reactivity is fine-grained. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Mention PySide6 and Pygfx renderers in README feature list Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent b46cbd9 commit c83966c

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
11
[![PyPI version](https://badge.fury.io/py/collagraph.svg)](https://badge.fury.io/py/collagraph)
22
[![CI status](https://github.com/fork-tongue/collagraph/workflows/CI/badge.svg)](https://github.com/fork-tongue/collagraph/actions)
3+
[![Docs](https://github.com/fork-tongue/collagraph/workflows/Docs/badge.svg)](https://fork-tongue.github.io/collagraph/)
34

45
# Collagraph 📓
56

67
Reactive user interfaces.
78

89
> The word [Collagraphy](https://en.wikipedia.org/wiki/Collagraphy) is derived from the Greek word _koll_ or _kolla_, meaning glue, and graph, meaning the activity of drawing.
910
10-
Inspired by Vue and React.
11+
Inspired by Vue and React. Check out the [documentation](https://fork-tongue.github.io/collagraph/) to get started.
1112

1213

1314
## Features
1415

15-
Write your Python interfaces in a declarative manner with plain render functions, component classes or even single-file components using Vue-like syntax, but with Python!
16+
Write your Python interfaces in a declarative manner as single-file components with Vue-like syntax (`.cgx` files), but with Python!
1617

17-
* Reactivity (made possible by leveraging [observ](https://github.com/fork-tongue/observ))
18+
* Fine-grained reactivity (made possible by leveraging [observ](https://github.com/fork-tongue/observ))
1819
* Class components with local state and life-cycle methods/hooks
1920
* Single-file components with Vue-like template syntax (`.cgx` files)
20-
* Custom renderers
21+
* Renderers for PySide6 and [Pygfx](https://github.com/pygfx/pygfx), with support for custom renderers
2122

2223
Here is an example that shows a counter, made with a component with Vue-like syntax:
2324

2425
Contents of `counter.cgx`:
2526
```html
2627
<widget>
27-
<label
28-
:text="f'Count: {count}'"
29-
/>
30-
<button
31-
text="bump"
32-
@clicked="bump"
33-
/>
28+
<label>Count: {{ count }}</label>
29+
<button @clicked="bump">bump</button>
3430
</widget>
3531

3632
<script>
@@ -81,7 +77,7 @@ To inspect the Python code that is compiled for a component, use the `--show-cod
8177
uv run collagraph --show-code examples/pyside/counter.cgx
8278
```
8379

84-
For more examples, please take a look at the [examples folder](examples).
80+
For more examples, please take a look at the [examples folder](examples). For guides and API reference, visit the [documentation](https://fork-tongue.github.io/collagraph/).
8581

8682
Currently there are two renderers:
8783

0 commit comments

Comments
 (0)