From fe0a3d938f96de0f802584eb7cded0a36da0fe74 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Mon, 31 Oct 2022 12:20:52 +1100 Subject: [PATCH] doc: update readmes --- README.md | 23 +++++++---------- packages/core/README.md | 56 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 14 deletions(-) create mode 100644 packages/core/README.md diff --git a/README.md b/README.md index 71204ea7c0..5c72eeb1c0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ -[![NPM](https://nodei.co/npm/js-waku.png)](https://npmjs.org/package/js-waku) - -![GitHub Action](https://img.shields.io/github/workflow/status/status-im/js-waku/CI) +![GitHub Action](https://img.shields.io/github/workflow/status/waku-org/js-waku/CI) [![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ) # js-waku -A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/). +A TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/). ## Documentation @@ -19,37 +17,34 @@ A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/1 API Documentation can also be generated locally: ```shell -git clone https://github.com/status-im/js-waku.git +git clone https://github.com/waku-org/js-waku.git cd js-waku npm install npm run doc ``` -## Changelog - -Release changelog can be found in [CHANGELOG.md](https://github.com/status-im/js-waku/blob/master/CHANGELOG.md). - ## Bugs, Questions & Features -If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/js-waku/issues/new/). +If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-waku/issues/new/). For general discussion, get help or latest news, join **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or the [Waku Telegram Group](https://t.me/waku_org). ## Roadmap -You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1). +You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1). ## Contributing -See [CONTRIBUTING.md](https://github.com/status-im/js-waku/blob/master/CONTRIBUTING.md). +See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md). ## License + Licensed and distributed under either of -* MIT license: [LICENSE-MIT](https://github.com/status-im/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT +- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT or -* Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/status-im/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0) +- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0) at your option. These files may not be copied, modified, or distributed except according to those terms. diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 0000000000..128a53849b --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,56 @@ +[![NPM](https://nodei.co/npm/@waku/core.png)](https://npmjs.org/package/@waku/core) + +![GitHub Action](https://img.shields.io/github/workflow/status/waku-org/js-waku/CI) +[![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ) + +# @waku/core + +Core components of js-waku, a TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/). + +## Documentation + +- [Quick start](https://docs.wakuconnect.dev/docs/quick_start/) +- [Full documentation](https://docs.wakuconnect.dev/) +- [API documentation (`master` branch)](https://js.waku.org/) +- [Waku Connect](https://wakuconnect.dev/) +- [Waku](https://wakunetwork.com/) +- [Vac](https://vac.dev/) + +API Documentation can also be generated locally: + +```shell +git clone https://github.com/waku-org/js-waku.git +cd js-waku +npm install +npm run doc +``` + +## Changelog + +Release changelog can be found in [CHANGELOG.md](https://github.com/waku-org/js-waku/blob/master/packages/core/CHANGELOG.md). + +## Bugs, Questions & Features + +If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-waku/issues/new/). + +For general discussion, get help or latest news, join **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or the [Waku Telegram Group](https://t.me/waku_org). + +## Roadmap + +You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1). + +## Contributing + +See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md). + +## License + +Licensed and distributed under either of + +- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT + +or + +- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0) + +at your option. These files may not be copied, modified, or distributed except according to those terms.