Home

Awesome

<p align="center"> <a href="https://js.ipfs.io" title="JS IPFS"> <img src="https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png" alt="IPFS in JavaScript logo" width="244" /> </a> </p> <h3 align="center"><b>TODO: Example Name</b></h3> <p align="center"> <b><i>TODO: Example Description</b></i> <br /> <br /> <img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200"> <br> <a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a> · <a href="https://githubbox.com/ipfs-examples/js-ipfs-examples/tree/master/examples/">View Demo</a> · <a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a> · <a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a> </p>

Table of Contents

About The Project

Getting Started

TODO: This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

TODO: This is an example of how to list things you need to use the software and how to install them.

$ npm install -g ipfs

Installation

TODO: This is an example of how to perform the installation

  1. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
    
  2. Install NPM packages
    npm install
    
  3. Start an IPFS node
     $ jsipfs daemon
     Initializing IPFS daemon...
     js-ipfs version: x.x.x
     System version: x64/darwin
     Node.js version: x.x.x
     Swarm listening on /ip4/127.0
     .... more output
    

Usage

TODO: Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

How to add a file to the local IPFS node:

$ jsipfs add ./hello-world.txt
added QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txt

For more examples, please refer to the Documentation

Documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the IPFS Examples Project (https://github.com/ipfs-examples/js-ipfs-examples)
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -a -m 'feat: add some amazing feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Want to hack on IPFS?

The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:

Read the Code of Conduct and JavaScript Contributing Guidelines.