Skip to content
This repository has been archived by the owner on Mar 23, 2023. It is now read-only.

Commit

Permalink
feat!: convert to typescript and publish as ESM only (#106)
Browse files Browse the repository at this point in the history
Updates all deps and converts to typescript

BREAKING CHANGE: this module is now ESM-only and uses the v3 @aws-sdk/s3-client
  • Loading branch information
achingbrain authored Mar 23, 2023
1 parent 1510c92 commit 0f372e1
Show file tree
Hide file tree
Showing 54 changed files with 726 additions and 1,511 deletions.
13 changes: 0 additions & 13 deletions .aegir.cjs

This file was deleted.

44 changes: 7 additions & 37 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,39 +1,9 @@
yarn.lock
package-lock.json
**/node_modules/
**/*.log
test/repo-tests*

# Logs
logs
*.log

coverage

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

build

# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules

lib
build
dist
docs
types
.docs
.coverage
node_modules
package-lock.json
yarn.lock
.vscode
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,36 @@
# datastore-s3 <!-- omit in toc -->

[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-datastore-s3.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-datastore-s3)
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-datastore-s3/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-datastore-s3/actions/workflows/js-test-and-release.yml)
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-datastore-s3/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-datastore-s3/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)

> IPFS datastore implementation backed by s3
## Table of contents <!-- omit in toc -->

- [Install](#install)
- [Browser `<script>` tag](#browser-script-tag)
- [Usage](#usage)
- [Create a Repo](#create-a-repo)
- [Examples](#examples)
- [Contribute](#contribute)
- [License](#license)
- [Contribute](#contribute-1)
- [Contribute](#contribute)

## Install

```console
$ npm i datastore-s3
```

### Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `DatastoreS3` in the global namespace.

```html
<script src="https://unpkg.com/datastore-s3/dist/index.min.js"></script>
```

## Usage

If the flag `createIfMissing` is not set or is false, then the bucket must be created prior to using datastore-s3. Please see the AWS docs for information on how to configure the S3 instance. A bucket name is required to be set at the s3 instance level, see the below example.
Expand All @@ -47,12 +54,6 @@ See [examples/full-s3-repo](./examples/full-s3-repo) for how to quickly create a

You can see examples of S3 backed ipfs in the [examples folder](examples/)

## Contribute

PRs accepted.

Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

Licensed under either of
Expand All @@ -62,8 +63,12 @@ Licensed under either of

## Contribute

Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-datastore-s3/issues).

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
23 changes: 0 additions & 23 deletions examples/full-s3-repo/README.md

This file was deleted.

81 changes: 0 additions & 81 deletions examples/full-s3-repo/create-s3-repo.js

This file was deleted.

65 changes: 0 additions & 65 deletions examples/full-s3-repo/index.js

This file was deleted.

24 changes: 0 additions & 24 deletions examples/full-s3-repo/package.json

This file was deleted.

Loading

0 comments on commit 0f372e1

Please sign in to comment.