-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |