@animatorkit/editor 0.5.0-beta → 0.6.0

package/README.md

@@ -1,20 +1,18 @@
 # Anime.js Editor
 
-A free visual editor for [anime.js](https://animejs.com) animations. Tweak durations, delays, easing curves, keyframes, and more in real time, then save the changes back to your source code as plain anime.js.
-
-The editor runs on [tweaks](https://github.com/juliangarnier/tweaks). Set it up in your project folder:
+A visual editor for [Anime.js](https://animejs.com) animations. Tweak durations, delays, easing curves, keyframes, and more in real time, then save the changes back to your source code as plain anime.js.
 
 ```bash
 npx @animatorkit/editor
 ```
 
-The command installs `animejs`, and `tweaks` and `@animatorkit/editor` as dev dependencies, when they are missing, adds the Vite plugin to your Vite config, or creates one when your project uses Vite with no config. Without Vite, it adds an `editor` script that starts the save server. It also creates `editor.config.json`, and points `AGENTS.md` and `CLAUDE.md` to `llm.txt`.
+The command installs what the editor needs and sets up your project: the Vite plugin with Vite, or an `editor` script that starts the save server without Vite.
 
-To update the editor, update `@animatorkit/editor` with your package manager, for example `npm i -D @animatorkit/editor@latest`. With Editor Kit, use the kit command instead, see [Editor Kit](#editor-kit).
+To update, run `npm i -D @animatorkit/editor@latest`, or the kit command with [Editor Kit](#editor-kit).
 
 ## With Vite
 
-The plugin loads the editor on every page `vite dev` serves and saves through the Vite server. Builds ship untouched.
+The plugin loads the editor in `vite dev` and saves through the Vite server. Your builds never include the editor.
 
 ```js
 // vite.config.js
@@ -26,7 +24,7 @@ export default defineConfig({ plugins: [editor()] });
 
 ## Without Vite
 
-Start the save server with the `editor` script that the setup command adds, then import the editor in your code:
+Start the save server, then import the editor in your code:
 
 ```bash
 npm run editor
@@ -36,11 +34,11 @@ npm run editor
 import '@animatorkit/editor';
 ```
 
-The script runs `animejs-editor serve`. To start it on another port, run `npm run editor 7349`.
+To use another port, run `npm run editor 7349`.
 
 ## Using the editor
 
-The editor reads every running `animate`, `createTimeline`, `utils.set`, and `createLayout` call that has an id:
+The editor lists every `animate`, `createTimeline`, `utils.set`, and `createLayout` call that has an `id`:
 
 ```js
 import { animate } from 'animejs';
@@ -52,41 +50,29 @@ animate('.box', {
 });
 ```
 
-## Demo pages
-
-On a page with no save server, such as a non-commercial public demo, disable saving right after the import. The panel and its versions keep working in the session, and the page never contacts a server:
-
-```js
-import { editor } from '@animatorkit/editor';
-
-editor.config({ save: false });
-```
-
-The editor plays each animation once. To keep a looping demo looping, turn the transport loop on by default with `editor.config({ defaultPlayback: { loop: true } })`.
-
-To open the demo on one animation or timeline child, select it by its id after the call that carries it:
-
-```js
-editor.select('letters pop');
-```
-
 ## Coding agents
 
-Point your coding agent to `node_modules/@animatorkit/editor/llm.txt`, the rules for writing animations the editor can edit.
+Point your coding agent to `node_modules/@animatorkit/editor/llm.txt`. It holds the rules for writing animations the editor can edit.
 
 ## Editor Kit
 
 The stagger, random, onScroll, spring, steps, and irregular editors and the on-page gizmo are Editor Kit features. The free version still shows, retimes, copies, and saves those values when your code uses them.
 
-Get Editor Kit at [https://animejs.com/animatorkit](https://animejs.com/animatorkit). To upgrade, run the kit command, then paste the Editor Kit key from your account page at animejs.com:
+Get Editor Kit at [animejs.com/animatorkit](https://animejs.com/animatorkit), then run the kit command in your project and paste the key from your account page:
 
 ```bash
 npx @animatorkit/editor kit
 ```
 
-It saves the key in your user config folder: `~/.config/animatorkit/` on macOS and Linux, `$XDG_CONFIG_HOME/animatorkit/` when that variable is set, and `%APPDATA%\animatorkit\` on Windows, downloads Editor Kit into `.animatorkit/`, which it adds to `.gitignore`, and installs it from there as an optional dependency, the `@animatorkit/editor-kit` package. With Vite, your config and your pages stay as they are: the plugin loads Editor Kit when it is installed. Without Vite, import `@animatorkit/editor-kit` in place of `@animatorkit/editor`. A build server or a teammate without a seat installs the project and gets the free editor. With Yarn 2 and later, set `nodeLinker: node-modules` in `.yarnrc.yml`. Yarn then fails an install without Editor Kit, so each developer and build server needs a seat.
+Run it again to update Editor Kit, or after cloning a project. Teammates and build servers without Editor Kit get the free editor. Without Vite, import `@animatorkit/editor-kit` instead of `@animatorkit/editor`.
+
+To go back to the free editor:
+
+```bash
+npx @animatorkit/editor free
+```
 
-Run the same command to update Editor Kit to the newest version your key allows, and after a clone to install it again, as git does not keep `.animatorkit/`. It moves `@animatorkit/editor` to the Editor Kit version. The two versions must match. A package manager only warns when they differ, and `npx @animatorkit/editor` then prints the kit command that matches them. To go back to the free editor, run `npx @animatorkit/editor free`. It removes Editor Kit from the project and keeps your key, which your other projects use. Without Vite, import `@animatorkit/editor` again in your pages. To remove the key from this machine, delete that `animatorkit` folder.
+See the [installation guide](https://animejs.com/documentation/editor/getting-started/installation) for the details.
 
 ## License
 

package/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 /*!
- * Anime.js Editor v0.5.0-beta
+ * Anime.js Editor v0.6.0
  * Copyright (c) Julian Garnier. All rights reserved.
  * Free to use under the Anime.js Editor License, see LICENSE.md. It may be redistributed only
  * as the unmodified @animatorkit/editor package, and it may not be copied or modified.