Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update project config #4

Merged
merged 2 commits into from
Jun 12, 2024
Merged

Conversation

achingbrain
Copy link
Member

Fixes linting, readme and project config.

Closes #3

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@achingbrain achingbrain requested a review from MarcoPolo June 11, 2024 13:12
Fixes linting, readme and project config.
@MarcoPolo MarcoPolo force-pushed the chore/update-project-config branch from 1eff273 to 5e12089 Compare June 11, 2024 23:33
* async function main () {
* const node = await createLibp2p({
* // other options ...
* services: {
* http: http()
* }
* })

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this why docs failed to generate for me?

Copy link
Member Author

@achingbrain achingbrain Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's because the package.json description field wasn't found in the README anywhere - basically this bit.

The README had:

> Implementation of WHATWG Fetch with support for multiaddr URIs and libp2p streams. Use HTTP in p2p networks.

..but it was looking for what was in the package.json:

> Implementation of the WHATWG Fetch API on libp2p streams

It could use printing an error message if it can't be found, tbh..

@MarcoPolo MarcoPolo force-pushed the chore/update-project-config branch from ca8e3cd to 692763b Compare June 11, 2024 23:36
@MarcoPolo MarcoPolo merged commit b321a4b into main Jun 12, 2024
12 checks passed
Copy link

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix readme generator
2 participants