Skip to content

Commit ac11af2

Browse files
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>
1 parent b46cbd9 commit ac11af2

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
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
@@ -81,7 +82,7 @@ To inspect the Python code that is compiled for a component, use the `--show-cod
8182
uv run collagraph --show-code examples/pyside/counter.cgx
8283
```
8384

84-
For more examples, please take a look at the [examples folder](examples).
85+
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/).
8586

8687
Currently there are two renderers:
8788

0 commit comments

Comments
 (0)