Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jackTabsCode committed May 26, 2024
1 parent 7714c9a commit 8ece102
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,19 @@ id = 9670971

- `id`: number

## Usage
## Commands

Just run `asphalt` and make sure you have a config file as specified above. When complete, it will generate a `asphalt.lock.toml` file which you should have committed to source control.
### `asphalt sync`

Uploads all assets in the `asset_dir` to Roblox. It will also generate a `asphalt.lock.toml` file which you should commit to source control.

### `asphalt list`

Lists asset paths from the lockfile and their corresponding Roblox asset IDs.

## API Key

You will need an API key to run Asphalt. You can specify this using the `--api-key` argument, or the `ASPHALT_API_KEY` environment variable.
You will need an API key to sync with Asphalt. You can specify this using the `--api-key` argument, or the `ASPHALT_API_KEY` environment variable.

You can get one from the [Creator Dashboard](https://create.roblox.com/dashboard/credentials). Make sure you select the correct group and Asset-related permissions.

Expand Down

0 comments on commit 8ece102

Please sign in to comment.