Skip to content

Commit 7db5019

Browse files
author
FMS-Cat
committed
docs: update README
1 parent 3bfd025 commit 7db5019

File tree

4 files changed

+20
-7
lines changed

4 files changed

+20
-7
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# ![Automaton](https://i.imgur.com/c4XRwNS.png)
1+
<p align="center">
2+
<img alt="Automaton" src="./readme-images/automaton.png"><br />
3+
</p>
24

3-
[![Inspect](https://github.com/FMS-Cat/automaton/workflows/Inspect/badge.svg)](https://github.com/FMS-Cat/automaton/actions)
5+
<p align="center">
6+
Animation engine for creative coding
7+
</p>
48

5-
Animation engine for creative coding
9+
[![Inspect](https://github.com/FMS-Cat/automaton/workflows/Inspect/badge.svg)](https://github.com/FMS-Cat/automaton/actions)
610

711
Originally made for [Shift](https://GitHub.com/fms-cat/shift), my WebGL demo
812

@@ -15,6 +19,17 @@ Originally made for [Shift](https://GitHub.com/fms-cat/shift), my WebGL demo
1519
- [`@fms-cat/automaton-with-gui`](./packages/automaton-with-gui) [![Latest NPM release](https://img.shields.io/npm/v/@fms-cat/automaton-with-gui.svg)](https://www.npmjs.com/package/@fms-cat/automaton-with-gui)
1620
- A variant of automaton that comes with GUI!
1721

22+
## Playground!
23+
24+
![Playground](./packages/automaton-with-gui/readme-images/playground.gif)
25+
26+
Try our playground!
27+
It comes with bunch of examples.
28+
29+
[https://fms-cat.github.io/automaton-with-gui](https://fms-cat.github.io/automaton/automaton-with-gui)
30+
31+
You might want to also check examples of [the core package](https://github.com/FMS-Cat/automaton/packages/automaton).
32+
1833
## License
1934

2035
[MIT](./LICENSE)

packages/automaton-with-gui/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# AutomatonWithGUI
2-
3-
![Automaton](https://i.imgur.com/c4XRwNS.png)
1+
# automaton-with-gui
42

53
[![Latest NPM release](https://img.shields.io/npm/v/@fms-cat/automaton-with-gui.svg)](https://www.npmjs.com/package/@fms-cat/automaton-with-gui)
64

@@ -12,7 +10,7 @@ Originally made for [Shift](https://GitHub.com/fms-cat/shift), my WebGL demo
1210

1311
## Playground!
1412

15-
![Playground](https://i.imgur.com/Ys4OdJb.gif)
13+
![Playground](./readme-images/playground.gif)
1614

1715
Try our playground!
1816
It comes with bunch of examples.
772 KB
Loading

readme-images/automaton.png

7.53 KB
Loading

0 commit comments

Comments
 (0)