Skip to content

Commit 3327012

Browse files
authored
Update README.md
1 parent f07372c commit 3327012

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
<div align="center">
22
<img src="doc/logo.svg">
3-
<h1>Cyma</h1>
3+
<h1>CYMA</h1>
44

55
[Documentation] | [Book] | [Examples] | [Contributing]
66

77
Composable views and associated data structures for <a href="https://github.com/robbert-vdh/nih-plug">nih-plug</a> UIs made using <a href="https://github.com/vizia/vizia">VIZIA</a>.
88

9-
109
<a href="https://github.com/exa04/cyma/actions/workflows/test.yml"><img src="https://github.com/exa04/cyma/actions/workflows/test.yml/badge.svg"></a>
1110
<a href="https://github.com/exa04/cyma/actions/workflows/docs.yml"><img src="https://github.com/exa04/cyma/actions/workflows/docs.yaml/badge.svg"></a>
1211
<a href="https://deps.rs/repo/github/exa04/cyma"><img src="https://deps.rs/repo/github/exa04/cyma/status.svg"></a>
@@ -21,7 +20,7 @@
2120

2221
## ✨ Overview
2322

24-
Cyma is a collection of flexible, composable views that you can use to make rich
23+
CYMA is a collection of flexible, composable views that you can use to make rich
2524
plug-in user interfaces with ease. It uses various custom data structures for
2625
real-time visualizers, allowing you to easily build beautiful, performant
2726
plug-in UIs.
@@ -32,6 +31,10 @@ https://github.com/user-attachments/assets/456a6705-5936-4118-a527-fb8999a91041
3231

3332
Wanna see the code behind this? It's [this example!](./examples/visualizers)
3433

34+
> [!TIP]
35+
> A version of Cyma that experimentally supports [`vizia-plug`](https://github.com/vizia/vizia-plug) instead of `nih-plug-vizia` is in the works.<br>
36+
> You can check it out on the [`vizia-plug` branch](https://github.com/exa04/cyma/tree/vizia_plug).
37+
3538
## 🧰 What's included
3639

3740
Do you think something's missing? File a feature request so it can be added!
@@ -125,7 +128,7 @@ system.
125128

126129
## 🍔 Composing views
127130

128-
A core feature of Cyma is composability.
131+
A core feature of CYMA is composability.
129132

130133
For example, by combining views such as the `Grid`, `UnitRuler`, `Graph`, and
131134
`Histogram` you can make this real-time peak graph with an RMS plot and a
@@ -191,11 +194,8 @@ ZStack::new(cx, |cx| {
191194

192195
## 🙋 Contributing
193196

194-
If you have questions about Cyma, need help with something, or want to show off
195-
what you built using it, head over to the [Discussions](https://github.com/223230/cyma/discussions) tab.
196-
197197
If you want to contribute through issues and code contributions, read the
198-
[Contributing Guidelines](./CONTRIBUTING.md) first
198+
[Contributing Guidelines](./CONTRIBUTING.md) first.
199199

200200
## 📃 License
201201

0 commit comments

Comments
 (0)