Skip to content

Commit

Permalink
docs: create readme
Browse files Browse the repository at this point in the history
  • Loading branch information
littensy committed Jul 30, 2023
1 parent 076c463 commit b712505
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# motion
🎨 An elegant motion library for Roblox
# 🎨 Motion

**Motion** is a simple, lightweight, and easy-to-use Roblox library for creating simple transitions and animations. It is inspired by [roact-spring](https://github.com/chriscerie/roact-spring) and is primarily intended to be a general-use alternative to [Flipper](https://github.com/Reselim/Flipper) for [Roblox-TS](https://roblox-ts.com).

You may use Motion with or without Roact. Currently, there is no package for using Motion with Roact.

## 📦 Installation

Motion is available on [NPM](https://www.npmjs.com/package/@rbxts/motion) and can be installed with the following commands:

```bash
npm install @rbxts/motion
yarn add @rbxts/motion
pnpm add @rbxts/motion
```

## 📚 Documentation

TODO

0 comments on commit b712505

Please sign in to comment.