Skip to content

Commit

Permalink
docs: add intro in the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
icfor committed Apr 17, 2024
1 parent c01e479 commit 787ae69
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,22 @@

A proof of concept application to stake tokens in XION, using the native
authentication via the dashboard.

## Development

The only dependency to run the project locally is Node.js. It has been tested
with Node.js v20. Once you have it installed, you can run:

```bash
npm install

npm run dev
```

It integrates the `@burnt-labs/abstraxion` library from
[xion.js](https://github.com/burnt-labs/xion.js).

The main part of the business logic that queries and interacts with XION
is in:

- [./src/features/staking/lib](./src/features/staking/lib)

0 comments on commit 787ae69

Please sign in to comment.