Skip to content

Commit

Permalink
chore: Add CLI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mattcroat committed Oct 1, 2023
1 parent 8d6af2f commit c3f4ca5
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 2 deletions.
33 changes: 33 additions & 0 deletions packages/create/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<br>
<div align="center">
<img width="400" src="packages/docs/static/logo.png" alt="Animotion logo" />
</div>
<br>

https://github.com/animotionjs/animotion/assets/38083522/da098a66-d2bb-4109-bc56-510894196d96

## Animotion

Animotion is a presentational framework for creating beautiful slides and visualizing ideas with code using [Svelte](https://svelte.dev/), [Reveal.js](https://revealjs.com/) and [Tailwind CSS](https://tailwindcss.com/).

## Setup

The quickest way to get started with Animotion.

```
npm create @animotion
```

You can run `npx @animotion/create` on Windows if that doesn't work.

## Docs

To learn how to use Animotion read the [Animotion documentation](https://animotion.pages.dev).

## Examples

You can look at the [examples repository](https://github.com/animotionjs/examples) if you want to understand how I use Animotion to visualize ideas with code. You can try the examples in the browser thanks to [SvelteLab](https://www.sveltelab.dev/).

## Contributing

If you want to contribute to the project you can read the [contributing guide](https://github.com/animotionjs/animotion/blob/main/CONTRIBUTING.md).
16 changes: 14 additions & 2 deletions packages/create/package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
{
"name": "@animotion/create",
"version": "1.0.1",
"version": "1.0.2",
"bin": "./cli/bin.js",
"type": "module",
"dependencies": {
"@clack/prompts": "^0.6.3"
}
},
"repository": {
"type": "git",
"url": "https://github.com/animotionjs/animotion.git",
"directory": "packages/create"
},
"keywords": [
"presentation",
"slides",
"svelte",
"reveal"
],
"homepage": "https://animotion.pages.dev/"
}

0 comments on commit c3f4ca5

Please sign in to comment.