Skip to content

Commit f23bd25

Browse files
committed
docs: update README
1 parent 27c7488 commit f23bd25

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

.lintstagedrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"*.{md,json,js,ts}": ["deno fmt"],
3-
"README.md": ["deno run -A npm:markdown-toc-gen@1 insert", "deno fmt"]
3+
"README.md": ["deno run -A --no-lock npm:markdown-toc-gen@1 insert", "deno fmt"]
44
}

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
- [Multiple Buckets or Namespaced Single Bucket](#multiple-buckets-or-namespaced-single-bucket)
1919
- [Features](#features)
2020
- [Methods](#methods)
21-
- [Contributing](#contributing)
2221
- [Testing](#testing)
2322
- [License](#license)
2423

@@ -79,9 +78,15 @@ This adapter can also be used on top on AWS' popular S3 service. To do so, simpl
7978
in the `url` provided to the adapter to point to `s3`:
8079

8180
```js
82-
minio({ url: 'https://accessKey:[email protected]', bucketPrefix: 'uniquePrefix' })
81+
minio({
82+
url: 'https://accessKey:[email protected]',
83+
region: 'us-east-2',
84+
bucketPrefix: 'uniquePrefix',
85+
})
8386
```
8487

88+
> `region` defaults to `us-east-1`
89+
8590
## Multiple Buckets or Namespaced Single Bucket
8691

8792
This adapter can be configured to either create a bucket, in the underying S3 or MinIO, per hyper
@@ -120,26 +125,21 @@ hyper Storage services `foo` and `bar`, the structure of the bucket would look l
120125

121126
## Features
122127

123-
- Create an `s3` bucket
124-
- Remove an `s3` bucket
125-
- List `s3` buckets
126-
- Put an object into an `s3` bucket
127-
- Remove an object from an `s3` bucket
128-
- Get an object from an `s3` bucket
129-
- List objects in an `s3` bucket
128+
- Create an `s3` compatible bucket
129+
- Remove an `s3` compatible bucket
130+
- List `s3` compatible buckets
131+
- Put an object into an `s3` compatible bucket
132+
- Remove an object from an `s3` compatible bucket
133+
- Get an object from an `s3` compatible bucket
134+
- List objects in an `s3` compatible bucket
130135

131136
## Methods
132137

133138
This adapter fully implements the Storage port and can be used as the
134-
[hyper Storage service](https://docs.hyper.io/storage-api) adapter
139+
[hyper Storage service](https://docs.hyper.io/docs/api-reference/rest/storage.html) adapter
135140

136141
See the full port [here](https://github.com/hyper63/hyper/tree/main/packages/port-storage)
137142

138-
## Contributing
139-
140-
Contributions are welcome! See the hyper
141-
[contribution guide](https://docs.hyper.io/oss/contributing-to-hyper)
142-
143143
## Testing
144144

145145
```

0 commit comments

Comments
 (0)