Skip to content

Commit

Permalink
Add changelog and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
loune committed Apr 27, 2019
1 parent 1326482 commit cef0196
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

## [2.0.0] - 2019-04-27

### Changed

- Support LevelDOWN `4.0.1`.
- Support new `abstract-leveldown` `6.0.3` tests.
- Constructor now takes `location` and `s3` parameters.
- `open` now creates the S3 bucket if `createIfMissing` is `true`

## [1.0.0] - 2017-02-05

- Initial Release
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,27 @@ db.batch()
});
```

## Example with min.io

You could also use s3leveldown with S3 compatible servers such as [MinIO](https://github.com/minio/minio).

```js
const levelup = require('levelup');
const s3leveldown = require('s3leveldown');
const AWS = require('aws-sdk');

const s3 = new AWS.S3({
apiVersion: '2006-03-01',
accessKeyId: 'YOUR-ACCESSKEYID',
secretAccessKey: 'YOUR-SECRETACCESSKEY',
endpoint: 'http://127.0.0.1:9000',
s3ForcePathStyle: true,
signatureVersion: 'v4'
});

const db = levelup(s3leveldown('my_bucket', s3));
```

## Sub folders

You can create your Level DB in a sub-folder in your S3 bucket, just use `my_bucket/sub_folder` when passing the location.
Expand Down

0 comments on commit cef0196

Please sign in to comment.