Skip to content

Commit

Permalink
refactor: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pawanpaudel93 committed Dec 22, 2024
1 parent a38f946 commit 64a3a7a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Create AO Contract

A CLI tool for scaffolding AO contracts, featuring [Busted](https://luarocks.org/modules/lunarmodules/busted) and [WAO](https://github.com/weavedb/wao) for testing and seamless deployment via [ao-deploy](https://github.com/pawanpaudel93/ao-deploy).
A CLI tool for scaffolding AO contracts, featuring [Busted](https://luarocks.org/modules/lunarmodules/busted) and [WAO](https://github.com/weavedb/wao) for testing, and seamless deployment via [ao-deploy](https://github.com/pawanpaudel93/ao-deploy).

## Table of Contents

Expand Down
32 changes: 25 additions & 7 deletions template/ao/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,61 @@ AO contract created using [create-ao-contract](https://github.com/pawanpaudel93/

1. Make sure you have [Lua](https://www.lua.org/start.html#installing) and [LuaRocks](https://github.com/luarocks/luarocks/wiki/Download) installed.

2. Install [arweave](https://luarocks.org/modules/crookse/arweave) using LuaRocks for testing purposes.
2. Install [arweave](https://luarocks.org/modules/crookse/arweave) using LuaRocks for testing, formatting, and linting purposes.

```bash
luarocks install arweave
```

**Note**: `arweave` package relies on `busted` for its testing capabilities.

3. **[Recommended]** Install [Lua Language Server](https://luals.github.io/#install) to make development easier, safer, and faster!. On VSCode, install extension: [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
- Install AO & Busted addon using Lua Addon Manager. On VSCode, goto `View > Command Palette > Lua: Open Addon Manager`

## Usage
## Installation

To install dependencies:
To install the project dependencies, run:

```bash
npm install
```

To run tests:
## Usage

To run tests, use:

```bash
npm run test
```

To deploy contract:
To deploy the contract, use:

```bash
npm run deploy
```

To format the code:
To format the code, use:

```bash
npm run format
```

To lint the code:
To lint the code, use:

```bash
npm run lint
```

## Contributing

If you wish to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a new Pull Request.

## Credits

This project was created using [create-ao-contract](https://github.com/pawanpaudel93/create-ao-contract).

0 comments on commit 64a3a7a

Please sign in to comment.