Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FabijanC committed Nov 27, 2023
1 parent 825a4d4 commit 307b0a9
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ npm ci
#### Compile a contract

```
npx hardhat starknet-compile contracts/contract.cairo
npx hardhat starknet-compile cairo1-contracts/contract1.cairo --single-file
```

#### Compile a deprecated (Cairo 0) contract

```
npx hardhat starknet-compile deprecated contracts/contract.cairo
```

### Set up environment variables
Expand All @@ -43,10 +49,10 @@ If you're having issues trying to use this example repo with the Starknet plugin

## Branches

- `master` - latest stable examples
- `plugin` - used for testing by [Starknet Hardhat Plugin](https://github.com/0xSpaceShard/starknet-hardhat-plugin)
- `master` - latest stable examples
- `plugin` - used for testing by [Starknet Hardhat Plugin](https://github.com/0xSpaceShard/starknet-hardhat-plugin)

### Branch updating (for developers)

- New PRs and features should be targeted to the `plugin` branch.
- After releasing a new plugin version, `master` should ideally be reset (fast forwarded) to `plugin` (less ideally merged).
- New PRs and features should be targeted to the `plugin` branch.
- After releasing a new plugin version, `master` should ideally be reset (fast forwarded) to `plugin` (less ideally merged).

0 comments on commit 307b0a9

Please sign in to comment.