Skip to content

Commit

Permalink
docs: readme references contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AustinWoetzel committed Nov 10, 2023
1 parent 3833281 commit 3f2aaf1
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ ShadeJS is a typescript SDK for interacting with <a href="https://shadeprotocol.
## Out of Scope
In its current state, ShadeJS does NOT include services to execute contracts via a <a href="https://secretjs.scrt.network/#integrations" target="_blank">Secret Signing Client.</a> This is becuase signing transactions requires a complex integration with multiple types of wallets. However, ShadeJS DOES include message creator functions for executions that can be easily imported into your project, so that you can call them from your own signing client manager.

## Contributing
Interested in contributing to this repository? Check our our [Contributing Guide](./docs/CONTRIBUTING.md).

<p align="center">
<img alt="npm" src="https://img.shields.io/npm/v/shadejs" />
Expand All @@ -17,7 +19,7 @@ In its current state, ShadeJS does NOT include services to execute contracts via
## Yarn
Yarn is the default package manager.

## Build
## Install
```
$ yarn
```
Expand All @@ -27,6 +29,11 @@ $ yarn
$ yarn test
```

## Build
```
$ yarn build
```

## Docs
Docs will be available on a vitepress site. You can run the site locally with this command:

Expand Down

0 comments on commit 3f2aaf1

Please sign in to comment.