From 6e42a6df87b636d93da9db5f40f3cd0b5e171514 Mon Sep 17 00:00:00 2001 From: billy rennekamp Date: Wed, 10 Feb 2021 22:54:45 +0100 Subject: [PATCH 1/6] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index fb34ca26..802e9552 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ like faucets/scrapers in the Cosmos ecosystem. "Cosm" is short for Cosmos and "JS" is short for _runs everywhere_ – we actually develop in TypeScript. +## Documentation +Documentation is hosted at cosmos.github.io/cosmjs. [Here is a list of examples](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9) using the stargate package for use with [Cosmos SDK v0.41.x](https://github.com/cosmos/cosmos-sdk/tree/v0.41.0) applications (like [gaia v0.4.0](https://github.com/cosmos/gaia/tree/v4.0.0)). Take a look at the wiki page, ["What can CosmJS do for me?"](https://github.com/cosmos/cosmjs/wiki/What-can-CosmJS-do-for-me%3F) and various tests ([ex](https://github.com/cosmos/cosmjs/blob/main/packages/stargate/src/signingstargateclient.spec.ts)) for more example usage of the packages. + ## Packages CosmJS is a library that consists of many smaller npm packages within the From 554f4d9977cd7220063ab0b81c15d89751d665a7 Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Thu, 11 Feb 2021 08:55:21 +0100 Subject: [PATCH 2/6] Disable pager --- .circleci/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 61839f68..25d5c737 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -73,7 +73,7 @@ jobs: echo "Error: repository contains changes." echo "Showing 'git status' and 'git diff' for debugging now:" git status - git diff + git --no-pager diff exit 1 fi test: @@ -639,6 +639,6 @@ jobs: echo "Error: repository contains changes." echo "Showing 'git status' and 'git diff' for debugging now:" git status - git diff + git --no-pager diff exit 1 fi From 0a503c55794a044c0d20e2181132cbe48d09c798 Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Thu, 11 Feb 2021 08:55:27 +0100 Subject: [PATCH 3/6] Format text --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 802e9552..7cad136a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,17 @@ like faucets/scrapers in the Cosmos ecosystem. develop in TypeScript. ## Documentation -Documentation is hosted at cosmos.github.io/cosmjs. [Here is a list of examples](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9) using the stargate package for use with [Cosmos SDK v0.41.x](https://github.com/cosmos/cosmos-sdk/tree/v0.41.0) applications (like [gaia v0.4.0](https://github.com/cosmos/gaia/tree/v4.0.0)). Take a look at the wiki page, ["What can CosmJS do for me?"](https://github.com/cosmos/cosmjs/wiki/What-can-CosmJS-do-for-me%3F) and various tests ([ex](https://github.com/cosmos/cosmjs/blob/main/packages/stargate/src/signingstargateclient.spec.ts)) for more example usage of the packages. + +Documentation is hosted at cosmos.github.io/cosmjs. +[Here is a list of examples](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9) +using the stargate package for use with +[Cosmos SDK v0.41.x](https://github.com/cosmos/cosmos-sdk/tree/v0.41.0) +applications (like [gaia v0.4.0](https://github.com/cosmos/gaia/tree/v4.0.0)). +Take a look at the wiki page, +["What can CosmJS do for me?"](https://github.com/cosmos/cosmjs/wiki/What-can-CosmJS-do-for-me%3F) +and various tests +([ex](https://github.com/cosmos/cosmjs/blob/main/packages/stargate/src/signingstargateclient.spec.ts)) +for more example usage of the packages. ## Packages From eb76d8dc1967ace377c1feb5f53252bd77da73fc Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Thu, 11 Feb 2021 09:08:43 +0100 Subject: [PATCH 4/6] Elaborate on documentatzion text --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7cad136a..f04ed3ca 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,29 @@ develop in TypeScript. ## Documentation -Documentation is hosted at cosmos.github.io/cosmjs. -[Here is a list of examples](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9) -using the stargate package for use with -[Cosmos SDK v0.41.x](https://github.com/cosmos/cosmos-sdk/tree/v0.41.0) -applications (like [gaia v0.4.0](https://github.com/cosmos/gaia/tree/v4.0.0)). -Take a look at the wiki page, +[Here is a list of examples][guided tour] using the Stargate package for use +with [Cosmos SDK 0.41] applications (like [gaia 4]). Take a look at the wiki +page, ["What can CosmJS do for me?"](https://github.com/cosmos/cosmjs/wiki/What-can-CosmJS-do-for-me%3F) and various tests ([ex](https://github.com/cosmos/cosmjs/blob/main/packages/stargate/src/signingstargateclient.spec.ts)) for more example usage of the packages. +[guided tour]: + https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9 +[cosmos sdk 0.41]: https://github.com/cosmos/cosmos-sdk/tree/v0.41.0 +[gaia 4]: https://github.com/cosmos/gaia/tree/v4.0.0 + +### API documentation + +The full API documentation is hosted at [cosmos.github.io/cosmjs]. This is a bit +tricky to navigate and requires basic TypeScript understanding. It is helpful if +you have want to look up details for advanced use cases. This documentation is +auto-generated based on the current main branch and can occasionally diverge +from the latest release. + +[cosmos.github.io/cosmjs]: https://cosmos.github.io/cosmjs + ## Packages CosmJS is a library that consists of many smaller npm packages within the From aded000c9f3adb53f2e5cedaa88174802d9051ce Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Thu, 11 Feb 2021 09:14:33 +0100 Subject: [PATCH 5/6] Update Roadmap section --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f04ed3ca..3902f2e1 100644 --- a/README.md +++ b/README.md @@ -85,11 +85,13 @@ can work on a solution with swapable implementations. ## Roadmap -In addition to the -[development board](https://github.com/orgs/cosmos/projects/6) and our -[release milestones](https://github.com/cosmos/cosmjs/milestones), we maintain a -higher level roadmap -[in this Trello board](https://trello.com/b/vIW8awLl/cosmjs-roadmap). +We maintain a [development board](https://github.com/orgs/cosmos/projects/6), +use [release milestones](https://github.com/cosmos/cosmjs/milestones) and share +important updates in the [CosmWasm Community Call]. For higher level roadmap +discussion please reach out to the team. + +[cosmwasm community call]: + https://github.com/CosmWasm/cosmwasm/issues?q=label%3A%22Community+Call+%F0%9F%97%BA%F0%9F%93%9E%22 ## Development From e5f1fef1c466c96fc6b38084724110085dfc9890 Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Thu, 11 Feb 2021 09:14:44 +0100 Subject: [PATCH 6/6] Add Get in touch section --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 3902f2e1..67ee8867 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,19 @@ discussion please reach out to the team. [cosmwasm community call]: https://github.com/CosmWasm/cosmwasm/issues?q=label%3A%22Community+Call+%F0%9F%97%BA%F0%9F%93%9E%22 +## Get in touch + +The CosmJS development team is happy to get in touch with you for all questions +and suggestions. + +- [GitHub issues](https://github.com/cosmos/cosmjs/issues) for bugs and feature + requests +- The #cosmjs channel on the + ["Cosmos Community" Discord server](https://discord.gg/vcExX9T) for questions + and open discussions +- [#CosmJS on Twitter](https://twitter.com/search?q=%23CosmJS) to spread the + word + ## Development See [HACKING.md](HACKING.md).