Skip to content

Commit 0465fac

Browse files
authored
bee-js name formatting (#239)
1 parent 588a687 commit 0465fac

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Bee JS Documentation Website
1+
# bee-js Documentation Website
22

33
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).
44

docs/documentation/soc-and-feeds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The `identifier` and Ethereum address together determine the SOC address and mus
117117

118118
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.
119119

120-
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.
120+
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.
121121

122122
:::info SOC address is derived from the identifier and owner
123123
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.

docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: introduction
33
slug: /
4-
title: "Bee JS - The Swarm JS Library"
4+
title: "bee-js - The Swarm JS Library"
55
sidebar_label: Introduction
66
---
77

docusaurus.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module.exports = {
2-
title: "Bee JS Library",
2+
title: "bee-js Library",
33
tagline: "Welcome to the Swarm",
44
// note! we use SED to change this during automated builds, see ./.github/workflows/gh-pages.yml
55
url: "https://bee-js.ethswarm.org",
@@ -18,7 +18,7 @@ module.exports = {
1818
defaultMode: "dark",
1919
},
2020
navbar: {
21-
title: "Bee Js Documentation",
21+
title: "bee-js Documentation",
2222
logo: {
2323
alt: "Swarm Logo",
2424
src: "img/swarm-logo-2.svg",

src/css/custom.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Custom CSS for Bee-JS Docs Site */
1+
/* Custom CSS for bee-js Docs Site */
22

33
@font-face {
44
font-family: 'Rubik';

0 commit comments

Comments
 (0)