diff --git a/README.md b/README.md index 490f2b76..1a754e76 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Bee JS Documentation Website +# bee-js Documentation Website Documentation for the [Swarm Bee-js javascript library](https://github.com/ethersphere/bee-js). View at [bee-js.ethswarm.org](https://bee-js.ethswarm.org). diff --git a/docs/documentation/soc-and-feeds.md b/docs/documentation/soc-and-feeds.md index 803b03dd..556a7288 100644 --- a/docs/documentation/soc-and-feeds.md +++ b/docs/documentation/soc-and-feeds.md @@ -117,7 +117,7 @@ The `identifier` and Ethereum address together determine the SOC address and mus To retrieve a previously uploaded SOC, you must know the Ethereum address of the owner (the signer used to upload the SOC) and the exact 32-byte `identifier` used during upload. These two values uniquely determine the SOC address in Swarm. -To download a SOC in Bee-JS, use the `makeSOCReader()` method. This method takes the owner's Ethereum address (as a `EthAddress` instance, a hex string, or a `Uint8Array`) and returns a `SOCReader` object. You can then call `.download(identifier)` on the reader to retrieve the chunk's data. +To download a SOC in bee-js, use the `makeSOCReader()` method. This method takes the owner's Ethereum address (as a `EthAddress` instance, a hex string, or a `Uint8Array`) and returns a `SOCReader` object. You can then call `.download(identifier)` on the reader to retrieve the chunk's data. :::info SOC address is derived from the identifier and owner Unlike uploads using content addressed chunks which are retrieved by their Swarm reference hash, SOCs are retrieved using the combination of `identifier` and `owner`, not their Swarm reference hash. diff --git a/docs/introduction.md b/docs/introduction.md index 68d07751..1398b73c 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,7 +1,7 @@ --- id: introduction slug: / -title: "Bee JS - The Swarm JS Library" +title: "bee-js - The Swarm JS Library" sidebar_label: Introduction --- diff --git a/docusaurus.config.js b/docusaurus.config.js index bb242134..9153fea8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,5 +1,5 @@ module.exports = { - title: "Bee JS Library", + title: "bee-js Library", tagline: "Welcome to the Swarm", // note! we use SED to change this during automated builds, see ./.github/workflows/gh-pages.yml url: "https://bee-js.ethswarm.org", @@ -18,7 +18,7 @@ module.exports = { defaultMode: "dark", }, navbar: { - title: "Bee Js Documentation", + title: "bee-js Documentation", logo: { alt: "Swarm Logo", src: "img/swarm-logo-2.svg", diff --git a/src/css/custom.css b/src/css/custom.css index 687f16d4..8345b1fc 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1,4 +1,4 @@ -/* Custom CSS for Bee-JS Docs Site */ +/* Custom CSS for bee-js Docs Site */ @font-face { font-family: 'Rubik';