Skip to content

Commit

Permalink
feat: consistent casing
Browse files Browse the repository at this point in the history
  • Loading branch information
drewdelano committed Oct 5, 2022
1 parent f585c0e commit 8b757ab
Show file tree
Hide file tree
Showing 60 changed files with 345 additions and 347 deletions.
2 changes: 1 addition & 1 deletion PEERS
@@ -1,4 +1,4 @@
# A list of known IPFS peers that are hosting content uploaded to Web3.Storage.
# A list of known IPFS peers that are hosting content uploaded to web3.storage.
#
# YOU DO NOT NEED THIS LIST. All peers that provide content on IPFS are
# discoverable via the DHT. IPFS transfers content P2P from multiple sources
Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -159,7 +159,7 @@ Our docs website is currently hosted in a [separate repo](https://github.com/web

## Learn more

To learn more about the Web3.Storage service, upload a file through our friendly UI, or find detailed documentation for the JS client library, please head over to https://web3.storage
To learn more about the web3.storage service, upload a file through our friendly UI, or find detailed documentation for the JS client library, please head over to https://web3.storage


<p align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/client/examples/node.js/README.md
Expand Up @@ -7,7 +7,7 @@ Examples for using the web3.storage client from Node.js.
- `put-car-from-fs.js` - Adds a Content Archive (CAR) file from your file system to web3.storage
- `put-car-dag-cbor.js` - Creates a Content Archive in memory from IPLD data and adds to web3.storage

See the [Working with CARs guide](https://web3.storage/docs/how-tos/work-with-car-files/) on the [Web3.Storage documentation site](https://web3.storage/docs) for more context about the examples relating to Content Archives.
See the [Working with CARs guide](https://web3.storage/docs/how-tos/work-with-car-files/) on the [web3.storage documentation site](https://web3.storage/docs) for more context about the examples relating to Content Archives.

## Setup

Expand Down
16 changes: 8 additions & 8 deletions packages/client/examples/node.js/put-car-dag-cbor.js
Expand Up @@ -6,7 +6,7 @@ import * as cbor from '@ipld/dag-cbor'
import { sha256 } from 'multiformats/hashes/sha2'
import { Web3Storage } from 'web3.storage'

// This file has a few examples of uploading structured IPLD data to Web3.Storage
// This file has a few examples of uploading structured IPLD data to web3.storage
// by creating a Content Archive (CAR) and using the putCar client method.
//
// See https://web3.storage/docs/how-tos/work-with-car-files/#advanced-ipld-formats
Expand All @@ -30,14 +30,14 @@ main()

/**
* Stores a simple "hello world" object as IPLD data, encoded using dag-cbor.
* @param {Web3.Storage} storage a Web3.Storage client
* @param {web3.storage} storage a web3.storage client
*/
async function simpleCborExample (storage) {
// encode the value into an IPLD block and store with Web3.Storage
// encode the value into an IPLD block and store with web3.storage
const block = await encodeCborBlock({ hello: 'world' })
const car = await makeCar(block.cid, [block])

// upload to Web3.Storage using putCar
// upload to web3.storage using putCar
console.log('🤖 Storing simple CBOR object...')
const cid = await storage.putCar(car)
console.log(`🎉 Done storing simple CBOR object. CID: ${cid}`)
Expand All @@ -46,7 +46,7 @@ async function simpleCborExample (storage) {

/**
* Stores a CBOR object that links to another CBOR object by CID.
* @param {Web3Storage} storage a Web3.Storage client
* @param {Web3Storage} storage a web3.storage client
*/
async function cborLinkExample (storage) {
// Encode a simple object to get its CID
Expand All @@ -62,7 +62,7 @@ async function cborLinkExample (storage) {
// pack everything into a CAR
const car = await makeCar(personBlock.cid, [personBlock, addressBlock])

// upload to Web3.Storage using putCar
// upload to web3.storage using putCar
console.log('🤖 Storing CBOR objects with CID links between them...')
const cid = await storage.putCar(car)
console.log('🎉 Stored linked data using dag-cbor. Root CID:', cid)
Expand All @@ -81,10 +81,10 @@ async function encodeCborBlock (value) {

/**
* Takes a root CID and an iterable of encoded IPLD blocks, and returns a CarReader that
* can be used with Web3.Storage.putCar
* can be used with web3.storage.putCar
* @param {string} rootCID the CID of the root block of the IPLD graph
* @param {Iterable<Block>} ipldBlocks a collection of encoded IPLD blocks
* @returns {CarReader} a CarReader for sending the CAR data to Web3.Storage
* @returns {CarReader} a CarReader for sending the CAR data to web3.storage
*/
async function makeCar (rootCID, ipldBlocks) {
return new CarReader(1, [rootCID], ipldBlocks)
Expand Down
2 changes: 1 addition & 1 deletion packages/client/examples/node.js/put-car-from-fs.js
Expand Up @@ -5,7 +5,7 @@ import { CarReader } from '@ipld/car'
import { Web3Storage } from 'web3.storage'

// This file has an example of storing a Content Archive (CAR) file using
// the Web3.Storage client's putCar method.
// the web3.storage client's putCar method.
//
// See https://web3.storage/docs/how-tos/work-with-car-files
// for more information about CARs.
Expand Down
2 changes: 1 addition & 1 deletion packages/cron/src/lib/email/service.js
Expand Up @@ -7,7 +7,7 @@ import DummyEmailProvider from './providers/dummy.js'

// We might want to make these configurable via method parameters in future:
const EMAIL_FROM_ADDR = 'support@web3.storage'
const EMAIL_FROM_NAME = 'Web3.Storage'
const EMAIL_FROM_NAME = 'web3.storage'

const log = debug('email:EmailService')

Expand Down
14 changes: 7 additions & 7 deletions packages/cron/test/email.spec.js
Expand Up @@ -68,7 +68,7 @@ describe('Mail service', () => {
aUser.email,
aUser.name,
'support@web3.storage',
'Web3.Storage',
'web3.storage',
templateVars
))
})
Expand Down Expand Up @@ -145,7 +145,7 @@ describe('Mailchimp provider', () => {

it('should call _sendTemplate', () => {
provider.sendEmail(
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'Web3.Storage', {}
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'web3.storage', {}
)
assert.ok(sendTemplate.calledOnce)
})
Expand All @@ -156,7 +156,7 @@ describe('Mailchimp provider', () => {
assert.rejects(
async () => {
await provider.sendEmail(
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'Web3.Storage', {}
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'web3.storage', {}
)
},
EmailSendError
Expand All @@ -165,7 +165,7 @@ describe('Mailchimp provider', () => {
assert.rejects(
async () => {
await provider.sendEmail(
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'Web3.Storage', {}
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'web3.storage', {}
)
},
EmailSendError
Expand All @@ -175,15 +175,15 @@ describe('Mailchimp provider', () => {
it('should return message ID if API call succeeds', async () => {
sendTemplate.returns([{ status: 'sent', _id: 'abc' }])
const returnVal = await provider.sendEmail(
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'Web3.Storage', {}
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'web3.storage', {}
)
assert.equal(returnVal, 'abc')
})

it('should pass template name corresponding to email type', async () => {
sendTemplate.returns([{ status: 'sent', _id: 'abc' }])
await provider.sendEmail(
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'Web3.Storage', {}
'User75PercentStorage', 'user@example.com', 'User Person', 'support@web3.storage', 'web3.storage', {}
)
const templateId = sendTemplate.getCall(0).args[0].template_name
assert.equal(templateId, 'user-storage-quota-warning')
Expand All @@ -196,7 +196,7 @@ describe('Mailchimp provider', () => {
'user@example.com',
'User Person',
'support@web3.storage',
'Web3.Storage',
'web3.storage',
{ colour: 'blue' }
)
const mergeVars = sendTemplate.getCall(0).args[0].message.merge_vars
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/theme/Footer/footer.json
@@ -1,7 +1,7 @@
{
"footer": {
"contact": {
"logo_text": "Web3.Storage",
"logo_text": "web3.storage",
"prompt": "Sign up for free using your email address or GitHub.",
"cta": {
"url": "https://web3.storage/login",
Expand Down
2 changes: 1 addition & 1 deletion packages/infra/heroku/grant-postgrest.sql
@@ -1,6 +1,6 @@
-- Authenticator login
GRANT web_anon TO authenticator;
-- Web3.Storage user
-- web3.storage user
GRANT web3_storage TO authenticator;
GRANT USAGE ON SCHEMA public TO web3_storage;
-- allow access to all tables/sequences/functions in the public schema currently
Expand Down
2 changes: 1 addition & 1 deletion packages/tools/package.json
@@ -1,7 +1,7 @@
{
"name": "@web3-storage/tools",
"version": "1.0.0",
"description": "Web3.Storage tools",
"description": "web3.storage tools",
"private": "true",
"main": "index.js",
"type": "module",
Expand Down
4 changes: 2 additions & 2 deletions packages/w3/README.md
Expand Up @@ -86,12 +86,12 @@ List IPNS names managed by this utility.

### `w3 name publish <keyId> <value>`

Publish a name revision to Web3.Storage.
Publish a name revision to web3.storage.

**❗️Experimental** this command may not work, may change, and may be removed.

⚠️ Name records are not _yet_ published to or updated from the IPFS network.
Working with name records simply updates the Web3.Storage cache of data.
Working with name records simply updates the web3.storage cache of data.

### `w3 name resolve <keyId>`

Expand Down
2 changes: 1 addition & 1 deletion packages/w3/bin.js
Expand Up @@ -65,7 +65,7 @@ cli.command('name list')
.action(Name.list)

cli.command('name publish <keyId> <value>')
.describe('Publish a name revision to Web3.Storage.')
.describe('Publish a name revision to web3.storage.')
.example('name publish k51qzi5uqu5dlcuzv5xhg1zqn48gobcvn2mx13uoig7zfj8rz6zvqdxsugka9z /ipfs/bafkreid7fbwjx4swwewit5txzttoja4t4xnkj3rx3q7dlbj76gvixuq35y')
.action(Name.publish)

Expand Down
2 changes: 1 addition & 1 deletion packages/website/README.md
@@ -1,6 +1,6 @@
# Website

Frontend build for the Web3.Storage website.
Frontend build for the web3.storage website.

## Getting Started

Expand Down
6 changes: 3 additions & 3 deletions packages/website/assets/code-snippets/how-to/dag-cbor.js
Expand Up @@ -25,11 +25,11 @@ async function makeCar (rootCID, ipldBlocks) {

// #region simpleCborExample
async function simpleCborExample () {
// encode the value into an IPLD block and store with Web3.Storage
// encode the value into an IPLD block and store with web3.storage
const block = await encodeCborBlock({ hello: 'world' })
const car = await makeCar(block.cid, [block])

// upload to Web3.Storage using putCar
// upload to web3.storage using putCar
const client = new Web3Storage({ token: process.env.WEB3STORAGE_TOKEN })
console.log('🤖 Storing simple CBOR object...')
const cid = await client.putCar(car)
Expand All @@ -53,7 +53,7 @@ async function cborLinkExample () {
// pack everything into a CAR
const car = await makeCar(personBlock.cid, [personBlock, addressBlock])

// upload to Web3.Storage using putCar
// upload to web3.storage using putCar
const client = new Web3Storage({ token: process.env.WEB3STORAGE_TOKEN })

console.log('🤖 Storing CBOR objects with CID links between them...')
Expand Down
4 changes: 2 additions & 2 deletions packages/website/assets/code-snippets/how-to/dag-json.js
Expand Up @@ -15,10 +15,10 @@ async function storeDagJSON (jsonObject) {
writer.put(block)
writer.close()

// create a new CarReader we can hand to Web3.Storage.putCar
// create a new CarReader we can hand to web3.storage.putCar
const reader = await CarReader.fromIterable(out)

// upload to Web3.Storage using putCar
// upload to web3.storage using putCar
console.log('uploading car.')
const client = new Web3Storage({ token: process.env.WEB3STORAGE_TOKEN })
const cid = await client.putCar(reader, {
Expand Down
Expand Up @@ -22,7 +22,7 @@ func main() {
}
filename := os.Args[1]

// Create a new Web3.Storage client using the token
// Create a new web3.storage client using the token
client, err := w3s.NewClient(w3s.WithToken(token))
if err != nil {
panic(err)
Expand All @@ -35,13 +35,13 @@ func main() {
}

basename := path.Base(filename)
// Upload to Web3.Storage
// Upload to web3.storage
fmt.Printf("Storing %s ...\n", basename)
cid, err := client.Put(context.Background(), file)
if err != nil {
panic(err)
}

gatewayURL := fmt.Sprintf("https://%s.ipfs.dweb.link/%s\n", cid.String(), basename)
fmt.Printf("Stored %s with Web3.Storage! View it at: %s\n", basename, gatewayURL)
fmt.Printf("Stored %s with web3.storage! View it at: %s\n", basename, gatewayURL)
}
2 changes: 1 addition & 1 deletion packages/website/assets/code-snippets/how-to/index.js
Expand Up @@ -44,7 +44,7 @@ async function storeWithProgress (files) {
console.log(`Uploading... ${pct.toFixed(2)}% complete`)
}

// makeStorageClient returns an authorized Web3.Storage client instance
// makeStorageClient returns an authorized web3.storage client instance
const client = makeStorageClient()

// client.put will invoke our callbacks during the upload
Expand Down
2 changes: 1 addition & 1 deletion packages/website/components/general/metadata.js
Expand Up @@ -14,7 +14,7 @@ import Head from 'next/head';
*/
const Metadata = ({
title = 'Web3 Storage - The simple file storage service for IPFS & Filecoin.',
description = "With web3.Storage you get all the benefits of decentralized storage and content addressing with the frictionless experience you expect in a modern storage solution. It’s fast and it's open.",
description = "With web3.storage you get all the benefits of decentralized storage and content addressing with the frictionless experience you expect in a modern storage solution. It’s fast and it's open.",
}) => (
<Head>
<title>{title}</title>
Expand Down
Expand Up @@ -41,9 +41,9 @@ const PinningRequestModal = ({ isOpen, onClose }) => {
<GradientBackground variant="saturated-variant" />
<h1 className="user-request-modal__heading">Request Bulk Pinning API Access</h1>
<p className="user-request-modal__description">
Web3.Storage is capable of efficiently ingesting billions of records. Whether or not your data is already on
web3.storage is capable of efficiently ingesting billions of records. Whether or not your data is already on
IPFS, we have simple API for bulk data import. You do not need to request bulk API access if you are just
looking to upload your data to Web3.Storage. Check out{' '}
looking to upload your data to web3.storage. Check out{' '}
<Link href="/docs/how-tos/pinning-services-api/">the docs</Link> for more details.
</p>
<form onSubmit={handleCreateUserRequest}>
Expand Down

0 comments on commit 8b757ab

Please sign in to comment.