Skip to content

Commit

Permalink
feat: rename package and make node-cache a peer dependency (#9)
Browse files Browse the repository at this point in the history 
* chore: rename from ipfs-storage to node-ipfs
* feat: make node-cache a peer dependency and don't export it
  • Loading branch information
@neilcampbell
neilcampbell authored Jan 8, 2024
1 parent afa3add commit bce79f3
Show file tree
Hide file tree
Showing 6 changed files with 220 additions and 63 deletions.
26 changes: 13 additions & 13 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code of Conduct - ipfs-storage
# Code of Conduct - node-ipfs

## Our Pledge

Expand All @@ -14,23 +14,23 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behaviour that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologising to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologising to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals but for the
- Focusing on what is best not just for us as individuals but for the
overall community

Examples of unacceptable behaviour include:

* The use of sexualised language or imagery, and sexual attention or
- The use of sexualised language or imagery, and sexual attention or
advances
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities
Expand Down Expand Up @@ -102,7 +102,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behaviour, harassment of an
standards, including sustained inappropriate behaviour, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any public interaction within
Expand All @@ -113,4 +113,4 @@ the community.
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
43 changes: 26 additions & 17 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
<!-- omit in toc -->
# Contributing to ipfs-storage

# Contributing to node-ipfs

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

> And if you like the project but don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues
<!-- omit in toc -->

## Table of Contents

- [Code of Conduct](#code-of-conduct)
Expand All @@ -25,42 +28,42 @@ All types of contributions are encouraged and valued. See the [Table of Contents
- [Commit Messages](#commit-messages)
- [Join The Project Team](#join-the-project-team)


## Code of Conduct

This project and everyone participating in it is governed by the
[ipfs-storage Code of Conduct](https://github.com/MakerXStudio/ipfs-storage/master/CODE_OF_CONDUCT.md).
[node-ipfs Code of Conduct](https://github.com/MakerXStudio/node-ipfs/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behaviour
to ts-object-mother.


## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/MakerXStudio/ipfs-storage/wiki).
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/MakerXStudio/node-ipfs/wiki).
Before you ask a question, it is best to search for existing [Issues](https://github.com/MakerXStudio/ipfs-storage/issues) that might help you. If you have found a relevant issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
Before you ask a question, it is best to search for existing [Issues](https://github.com/MakerXStudio/node-ipfs/issues) that might help you. If you have found a relevant issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/MakerXStudio/ipfs-storage/issues/new).
- Open an [Issue](https://github.com/MakerXStudio/node-ipfs/issues/new).

We will then take care of the issue as soon as possible.

## I Want To Contribute

> ### Legal Notice <!-- omit in toc -->
>
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
### Reporting Bugs

<!-- omit in toc -->

#### Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/MakerXStudio/ipfs-storage/wiki). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/MakerXStudio/ipfs-storageissues?q=label%3Abug).
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/MakerXStudio/node-ipfs/wiki). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/MakerXStudio/node-ipfs/issues?q=label%3Abug).
- Also, make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
Expand All @@ -70,16 +73,18 @@ A good bug report shouldn't leave others needing to chase you up for more inform
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

<!-- omit in toc -->

#### How Do I Submit a Good Bug Report?

> You must never report security-related issues, vulnerabilities or bugs, including sensitive information, to the issue tracker or elsewhere in public. Instead, sensitive bugs must be sent by email to <opensource@makerx.com.au>.
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/MakerXStudio/ipfs-storage/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Open an [Issue](https://github.com/MakerXStudio/node-ipfs/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behaviour you would expect and the actual behaviour.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem and create a reduced test case.
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.

Once it's filed:
Expand All @@ -90,26 +95,28 @@ Once it's filed:

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for ipfs-storage, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
This section guides you through submitting an enhancement suggestion for node-ipfs, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

<!-- omit in toc -->

#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://github.com/MakerXStudio/ipfs-storage/wiki) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/MakerXStudio/ipfs-storage/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Read the [documentation](https://github.com/MakerXStudio/node-ipfs/wiki) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/MakerXStudio/node-ipfs/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're targeting a minority of users, consider writing an add-on/plugin library.

<!-- omit in toc -->

#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/MakerXStudio/ipfs-storage/issues).
Enhancement suggestions are tracked as [GitHub issues](https://github.com/MakerXStudio/node-ipfs/issues).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **detailed description of the suggested enhancement** in as many details as possible.
- **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. At this point, you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part to which the suggestion is related. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
- **Explain why this enhancement would be useful** to most ipfs-storage users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- **Explain why this enhancement would be useful** to most node-ipfs users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

## Styleguides

Expand All @@ -118,5 +125,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/MakerX
We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for our git message format

<!-- omit in toc -->

## Attribution
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IPFS Storage (ipfs-storage)
# Node IPFS (node-ipfs)

> A NodeJS package that makes interacting with IPFS easier
Expand All @@ -15,7 +15,7 @@ Ensure you are authenticated to the [GitHub package repository with your PAT](ht
```

```bash
npm install @makerxstudio/ipfs-storage
npm install @makerxstudio/node-ipfs
```

> [!NOTE]
Expand All @@ -27,7 +27,8 @@ The primary purpose of this package is to make reading and writing files on the

```typescript
import { S3 } from '@aws-sdk/client-s3'
import { PinataStorageWithCache, S3ObjectCache } from '@makerxstudio/ipfs-storage'
import { PinataStorageWithCache } from '@makerxstudio/node-ipfs'
import { S3ObjectCache } from '@makerxstudio/node-cache'

const s3Cache = new S3ObjectCache(
new S3({
Expand Down Expand Up @@ -68,9 +69,9 @@ In order to use this library you'll need to [signup for a free account on Pinata

---

[build-img]: https://github.com/MakerXStudio/ipfs-storage/actions/workflows/release.yaml/badge.svg
[build-url]: https://github.com/MakerXStudio/ipfs-storage/actions/workflows/release.yaml
[issues-img]: https://img.shields.io/github/issues/MakerXStudio/ipfs-storage
[issues-url]: https://github.com/MakerXStudio/ipfs-storage/issues
[build-img]: https://github.com/MakerXStudio/node-ipfs/actions/workflows/release.yaml/badge.svg
[build-url]: https://github.com/MakerXStudio/node-ipfs/actions/workflows/release.yaml
[issues-img]: https://img.shields.io/github/issues/MakerXStudio/node-ipfs
[issues-url]: https://github.com/MakerXStudio/node-ipfs/issues
[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]: https://github.com/semantic-release/semantic-release
Loading

0 comments on commit bce79f3

Please sign in to comment.