Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronCQL committed Jul 3, 2023
1 parent 9c631d2 commit 628c9de
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,35 @@
<!-- omit in toc -->
# CosmES

[![npm version](https://badge.fury.io/js/cosmes.svg)](https://www.npmjs.com/package/cosmes)

A tree-shakeable, framework agnostic, [pure ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) alternative of [CosmJS](https://github.com/cosmos/cosmjs) and [Cosmos Kit](https://cosmoskit.com).

- [Install](#install)
- [Examples](#examples)
- [Subdirectories](#subdirectories)
- [Exports](#exports)
- [`cosmes/client`](#cosmesclient)
- [`cosmes/codec`](#cosmescodec)
- [`cosmes/protobufs`](#cosmesprotobufs)
- [`cosmes/wallet`](#cosmeswallet)
- [Benchmarks](#benchmarks)
- [Contributing](#contributing)

## Install

```sh
npm install cosmes

pnpm i cosmes

yarn add cosmes
```

## Examples

Docs do not exist yet - see the [`examples`](./examples) folder for various working examples.

## Subdirectories
## Exports

This package is split into multiple subdirectories, with each subdirectory having their own set of functionalities. The root directory does not contain any exports, and all exports are exported from the subdirectories. Thus, imports must be done by referencing the subdirectories (ie. `import { ... } from "cosmes/client"`).

Expand All @@ -36,7 +49,7 @@ This directory contains the auto-generated code for various Cosmos SDK based pro

This directory is a [Cosmos Kit](https://cosmoskit.com) alternative to manage various wallets (Keplr, Station, Cosmostation, Leap, etc.) across various different Cosmos SDK based blockchains. See [`examples/solid-vite`](./examples/solid-vite) for a working example.

**Note**: to use Station via WalletConnect v1, a polyfill on `Buffer` is required. See [`examples/solid-vite`](./examples/solid-vite/src/polyfill.ts) for an example on how to do this. Other wallets that are using WalletConnect v2 should work out of the box.
**Note**: to use Station via WalletConnect v1, a polyfill for `Buffer` is required. See [`examples`](./examples/solid-vite/src/polyfill.ts) for an example on how to do this. Other wallets that are using WalletConnect v2 should work out of the box.

## Benchmarks

Expand Down

0 comments on commit 628c9de

Please sign in to comment.