@wonderyard/vivarium 0.1.5 → 0.1.7

package/README.md

@@ -1,6 +1,8 @@
 # Vivarium
 
-⚠️ Work in progress ⚠️
+<p align="center">
+  <img src="docs/banner.png" />
+</p>
 
 ## Introduction
 
@@ -8,13 +10,13 @@ Vivarium is a TypeScript library that aims to provide a simple yet expressive wa
 
 Vivarium exposes a minimal API that attempts to express complex rules and conditions in a way that resembles natural language. Concepts and technical terms from the cellular automata theory are almost transparent to the user. This way the cognitive effort of translating ideas into code is reduced. By lowering this barrier we enable fast prototyping during the creative coding process, especially for users who are approaching the cellular automata world for the first time.
 
-Read the **WIP** [docs] to get started, or continue reading for a quick overview and **WIP** [demo].
+Read the [docs](https://vivarium.orangenote.dev) to get started, or continue reading for a quick overview and [demo](https://vivarium-demo.netlify.app/).
 
 ## Overview
 
 ### Install
 
-Install Vivarium as a dependency. No other dependecies required.
+Install Vivarium as a dependency. No other dependencies required.
 
 ```bash
 npm i @wonderyard/vivarium
@@ -32,37 +34,37 @@ yarn add @wonderyard/vivarium
 
 Import it once and use it anywhere.
 
-```TypeScript
+```typescript
 import { vivarium, setup } from "@wonderyard/vivarium";
 ```
 
 ### Create
 
-To give you an idea of what the API can offer and how intuitive it can be to reason about rules and conditions, we recreated the most popular cellular automaton: [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life). Now featuring (with a little bit of imagination) orange cats 🐈
+To give you an idea of what the API can offer and how intuitive it can be to reason about rules and conditions, we recreated the most popular cellular automaton: [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life). Now featuring (with a little bit of imagination) green aliens 👽
 
-> We suggest you to read about Game of Life and how it works before continuing reading. If you don't understand clearly what the following code is representing, it's okay! Visit the **WIP** [docs] for a gentler introduction to cellular automata and what vivarium is meant for.
+> We suggest you to read about Game of Life and how it works before continuing reading. If you don't understand clearly what the following code is representing, it's okay! Visit the [docs](https://vivarium.orangenote.dev) for a gentler introduction to cellular automata and what vivarium is meant for.
 
-```TypeScript
+```typescript
 const vi = vivarium();
 
-const space = vi.element("space", "white");
-const cat = vi.element("cat", "orange");
+const space = vi.element("space", "blue");
+const alien = vi.element("alien", "green");
 
-// A cat is born if there's a family of 3 in the area.
-space.to(cat).count(cat, 3);
+// An alien is born if there's a family of 3 in the area.
+space.to(alien).count(alien, 3);
 
-// The cat stays if the area is neither too empty nor too crowded...
-cat.to(cat).count(cat, 2, 3);
+// The alien stays if the area is neither too empty nor too crowded...
+alien.to(alien).count(alien, 2, 3);
 
-// ...otherwise the cat will leave the area forever.
-cat.to(space);
+// ...otherwise the alien will leave the area forever.
+alien.to(space);
 
 const life = vi.create();
 ```
 
 ### Run
 
-```TypeScript
+```typescript
 // Create a new canvas (or you could use an existing one)
 const canvas = document.createElement(canvas);
 document.body.appendChild(canvas);
@@ -83,7 +85,7 @@ const loop = async () => {
 requestAnimationFrame(loop);
 ```
 
-**WIP** [See the live demo here]
+[See the live demo here](https://vivarium-demo.netlify.app/)
 
 ## Browser compatibility
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wonderyard/vivarium",
   "description": "Modern, intuitive, WebGPU-powered toolkit for creating your own cellular automata.",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "repository": "https://github.com/WonderYard/vivarium",
   "license": "MIT",
   "author": "OrangeNote",