Skip to content

Add install instruction into README documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Waffle0823 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add install instruction into README documentation #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
# rbxts-transform-debug
A debugging transformer for roblox-ts. Contains helper functions for debugging roblox-ts code with debug information attached.

## Installation

1. Add the package to your roblox-ts project:
```sh
npm install rbxts-transform-debug --save-dev
```

2. Configure tsconfig.json
```json
{
"compilerOptions": {
"plugins": [
{
"transform": "rbxts-transform-debug"
}
]
}
}
```

## How it works

Say we have this example code:
Expand Down