Skip to content

Commit 51684aa

Browse files
committed
README updates
1 parent 6ca9d51 commit 51684aa

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Schema URI | `https://schemas.video-notation.com/video-notation.schema@v1.0.0
2121

2222
| Area | Highlights |
2323
| -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
24-
| **Detailed metadata** | Duration, aspect ratio, resolution, language, target audience, accessibility flags, \&c. |
24+
| **Detailed metadata** | Duration, aspect ratio, resolution, language, target audience, accessibility flags, etc. |
2525
| **Character definitions** | Rich, reusable character profiles with wardrobe, personality, and vocal traits. |
2626
| **Global styling** | Consistent visual and auditory themes (camera, lighting, tone, audio) across the entire video. |
2727
| **Scene‑by‑scene control** | Unique parameters for each scene, including location, environment, subjects, props, motion graphics, and dialogue. |
@@ -46,7 +46,7 @@ The root object is organised into the following top‑level sections:
4646
| `scenes` | An array of individual scenes, each with its own specific settings and overrides. |
4747
| `annotations` | Production and post‑production notes, including external asset references. |
4848

49-
For a complete breakdown of every field and its type, refer to [`video-notation.schema.json`](.schema/video-notation.schema.json).
49+
For a complete breakdown of every field and its type, refer to [`video-notation.schema.json`](schema/video-notation.schema.json).
5050

5151
---
5252

@@ -63,15 +63,16 @@ The **Video Notation Schema** addresses these challenges by providing:
6363
- **Enhanced workflows** – Streamline prompting for individuals and teams, enabling efficient iteration and faster delivery.
6464
- **Versionability** – JSON prompts integrate seamlessly with version‑control systems such as Git, allowing transparent tracking of changes, collaborative review, and simple roll‑backs.
6565

66-
In essence, the schema transforms abstract creative concepts into concrete, actionable instructions for AI, unlocking new possibilities for storytelling and visual communication.
66+
In essence, the schema translates abstract creative concepts into concrete, actionable instructions for AI, unlocking new possibilities for storytelling and visual communication.
6767

6868
---
6969

7070
## 🚀 Getting Started
7171

72-
### 1. Use Video Notation Studio *(recommended)*
72+
### 1. Use Video Notation Studio
7373

74-
The web‑based **Video Notation Studio** provides a guided interface with validation, real-time visualisation and the ability to export your completed JSON prompt.
74+
Our web‑based **Video Notation Studio** provides a guided interface with validation, real-time visualisation, and the ability to export your completed JSON prompt.
75+
The Studio is fully browser-based and uses local storage only — your work is saved privately in your browser and never uploaded or shared.
7576

7677
#### Studio Screenshot
7778

@@ -84,7 +85,7 @@ The web‑based **Video Notation Studio** provides a guided interface with valid
8485

8586
Install a JSON Schema aware editor or plugin (e.g. Visual Studio Code with the **YAML** or **JSON Schema** extension). Add a `$schema` key to the top of your file to enable validation and autocompletion.
8687

87-
### 3. Create a prompt – minimal example
88+
**Prompt – minimal example:**
8889

8990
```jsonc
9091
{
@@ -106,9 +107,11 @@ Install a JSON Schema aware editor or plugin (e.g. Visual Studio Code with the
106107
}
107108
```
108109

109-
Fully‑featured sample prompts are available at [`examples/examples.md`](./examples/examples.md).
110+
Fully‑featured sample prompts are available at [`examples/examples.md`](/examples/examples.md).
110111

111-
### 4. Use prompt with models
112+
---
113+
114+
## Use prompt with models
112115

113116
Use your JSON prompt with any text-to-video AI video generation model.
114117

@@ -128,7 +131,7 @@ Released under the **Apache License 2.0**. See [`LICENSE`](LICENSE) for the fu
128131

129132
### 🛠 Maintainer
130133

131-
The schema was authored by **Nikolaos Maniatis** and is maintained and distributed by **The Cato Bot Company Limited**.
134+
The schema was authored by [**Nikolaos Maniatis**](https://github.com/nikmaniatis) and is maintained and distributed by **The Cato Bot Company Limited**.
132135

133136
Raise an **[issue](https://github.com/context-notation/video-notation-schema/issues/new)** in this repository if you have found a bug or would like to suggest an addition.
134137

@@ -137,16 +140,14 @@ For commercial enquiries, long-term support, or integration partnerships, please
137140

138141
---
139142

140-
## Citation
141-
142143
If you use the Video Notation Schema in academic work, please cite:
143144

144-
**Nikolaos Maniatis.** *Video Notation Schema (v1.0.0)*.
145-
https://schemas.video-notation.com/video-notation.schema@v1.0.0
146-
Available at: https://github.com/context-notation/video-notation-schema
145+
**Nikolaos Maniatis.** *Video Notation Schema (v1.0.0)*.
146+
<https://schemas.video-notation.com/video-notation.schema@v1.0.0>
147+
Available at: <https://github.com/context-notation/video-notation-schema>
147148
Licensed under Apache 2.0. Maintained by The Cato Bot Company Limited.
148149

149-
APA:
150-
Maniatis, N. (2025). *Video Notation Schema (v1.0.0)*. https://github.com/context-notation/video-notation-schema
150+
**APA:**
151+
Maniatis, N. (2025). *Video Notation Schema (v1.0.0)*. Retrieved from <https://github.com/context-notation/video-notation-schema>
151152

152153
---

0 commit comments

Comments
 (0)