From 628c9deff8549e0f5d6a921961ed183cd686b005 Mon Sep 17 00:00:00 2001 From: Aaron Choo Date: Mon, 3 Jul 2023 15:50:07 +0800 Subject: [PATCH] docs: improve readme --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0c559c9d..42788b55 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # 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) @@ -12,11 +15,21 @@ A tree-shakeable, framework agnostic, [pure ESM](https://gist.github.com/sindres - [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"`). @@ -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