Skip to content

Commit 4286865

Browse files
authored
Reorganize readme (#551)
1 parent f6d7672 commit 4286865

File tree

2 files changed

+28
-9
lines changed

2 files changed

+28
-9
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Contributions to OpenZeppelin Contracts Wizard are welcome. Please review the in
1414
The following prerequisites are required to build the project locally:
1515
- [Node.js](https://nodejs.org/)
1616
- [Yarn](https://yarnpkg.com/getting-started/install)
17-
- [Deno](https://github.com/denoland/deno?tab=readme-ov-file#installation) to run a local API server for the AI Assistant
17+
- [Deno](https://github.com/denoland/deno?tab=readme-ov-file#installation) (Optional) to run a local API server for the AI Assistant
1818
- Note that using the shell installation method is recommended (the `upgrade` command, which allows you to install a specific Deno version, is not always available when installing Deno with other installers).
1919
- To install the version of Deno that matches the Netlify deploy environment, run `deno upgrade --version 1.46.3`.
2020
- When adding dependencies for the Deno app add the dependency as a dev dependency using yarn, map the dependency to the Deno equivalent url in import_map.json and import it like a typescript dependency in the app.

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,19 @@ Contracts Wizard is a web application to interactively build a contract out of c
1010

1111
[![](./screenshot.png)](https://wizard.openzeppelin.com/)
1212

13-
## Contributing
13+
## Usage
14+
15+
Use the Contracts Wizard at https://wizard.openzeppelin.com/
16+
17+
## TypeScript API
1418

15-
See our [contributing guidelines](CONTRIBUTING.md).
19+
You can use the programmatic TypeScript API to generate contracts from your own applications.
20+
21+
View the API documentation for each smart contract language:
22+
- [Solidity](packages/core/solidity/README.md)
23+
- [Cairo](packages/core/cairo/README.md)
24+
- [Stellar](packages/core/stellar/README.md)
25+
- [Stylus](packages/core/stylus/README.md)
1626

1727
## Embedding
1828

@@ -28,11 +38,20 @@ Optionally focus on specific tab with the `data-tab` attribute as in `<oz-wizard
2838

2939
For languages other than Solidity, use the `data-lang` attribute, for example: `<oz-wizard data-lang="cairo"></oz-wizard>`.
3040

31-
## API
41+
## Contributing
42+
43+
We welcome contributions from the community! Here's how you can get involved:
44+
45+
1. Fork the repository
46+
2. Create your feature branch
47+
3. Commit your changes
48+
4. Push to the branch
49+
5. Create a Pull Request
50+
51+
If you are looking for a good place to start, find a good first issue [here](https://github.com/openzeppelin/contracts-wizard/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22), or [open an issue](https://github.com/OpenZeppelin/contracts-wizard/issues/new) for a bug report or feature request.
52+
53+
You can find more details in our [Contributing](CONTRIBUTING.md) guide.
3254

33-
The following describes how to use the Contracts Wizard programmatic API in your own applications.
55+
## License
3456

35-
- [Contracts Wizard API for Solidity](packages/core/solidity/README.md)
36-
- [Contracts Wizard API for Cairo](packages/core/cairo/README.md)
37-
- [Contracts Wizard API for Stellar](packages/core/stellar/README.md)
38-
- [Contracts Wizard API for Stylus](packages/core/stylus/README.md)
57+
This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)