Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

docs: Added update to packages/ipfs-http-client/README.md for Issue #4072 #4088

Merged
merged 1 commit into from
Jun 10, 2022

Conversation

ShehanAT
Copy link
Contributor

Description

This is a README.md update for the following file: js-ipfs/packages/ipfs-http-client/README.md.

It involved updating a line in the Example section, from this line:
const client = create('http://127.0.0.1:5002')
to this line:
const client = create({ url: "http://127.0.0.1:5002/api/v0" });

This change fixes #4072

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update

How Has This Been Tested?

No tests run as this PR is a simple documentation update.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@welcome
Copy link

welcome bot commented Apr 24, 2022

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines

    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@BigLep BigLep requested a review from achingbrain May 27, 2022 14:05
@BigLep BigLep merged commit 14e506a into ipfs:master Jun 10, 2022
SgtPooki referenced this pull request in ipfs/js-kubo-rpc-client Aug 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README examples throw type errors
2 participants