Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
littensy committed Apr 23, 2023
1 parent c854020 commit 1142716
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

An opinionated collection of useful hooks and utilites for Roblox-TS and [Roact Hooked](https://github.com/littensy/rbxts-roact-hooked/).

Every hook has documentation and tests. If you find a bug or have a feature request, please [open an issue](https://github.com/littensy/pretty-roact-hooks/issues/new/).

 

## ⭐ Featured
Expand Down Expand Up @@ -45,6 +47,22 @@ pnpm add @rbxts/roact-hooked

 

## 🌻 Contributing

Contributions are welcome! Note that if you make a change to a hook, you should also check the tests and documentation.

To get started, clone the repository and run `npm install` or `pnpm install`. Then, you can run the following commands:

- `pnpm dev` - Enable watch mode with the `game` project type
- `pnpm build` - Build the package

You will likely need the following extensions:

- [Rojo VSCode extension](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo)
- [TestEZ Companion](https://marketplace.visualstudio.com/items?itemName=tacheometrist.testez-companion)

 

## 📝 License

set-timeout is licensed under the [MIT License](LICENSE.md).

0 comments on commit 1142716

Please sign in to comment.