The JavaScript implementation of the IPFS protocol
\r\n\r\n
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n \r\n
\r\n\r\n# ipfs-core \r\n\r\n`ipfs-core` is the implementation of the IPFS Core API written in JavaScript without depending on other languages/implementations. It contains all you need to integrate IPFS into your application.\r\n\r\nIf you want to run IPFS as a standalone daemon process, see the [ipfs](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs) module.\r\n\r\n## Getting Started\r\n\r\nThe `ipfs-core` package contains all the features of `ipfs` but in a lighter package without the CLI or HTTP servers:\r\n\r\n```console\r\n$ npm install ipfs-core\r\n```\r\n\r\nThen start a node in your app:\r\n\r\n```javascript\r\nimport * as IPFS from 'ipfs-core'\r\n\r\nconst ipfs = await IPFS.create()\r\nconst { cid } = await ipfs.add('Hello world')\r\nconsole.info(cid)\r\n// QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf\r\n```\r\n\r\n## Next Steps\r\n\r\n- Look into the [js-ipfs-examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser\r\n- Read the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node\r\n- Head over to to take interactive tutorials that cover core IPFS APIs\r\n- Check out for tips, how-tos and more\r\n- See for news and more\r\n- Need help? Please ask 'How do I?' questions on \r\n\r\n### Browser CDN\r\n\r\nYou can load IPFS right in your browser by adding the following to your page using the super fast [jsdelivr](https://www.jsdelivr.com) CDN:\r\n\r\n```html\r\n\r\n\r\n\r\n\r\n\r\n```\r\n\r\nInserting one of the above lines will make an `IpfsCore` object available in the global namespace:\r\n\r\n```html\r\n\r\n```\r\n\r\n### Browser bundle\r\n\r\nLearn how to bundle IPFS into your application with webpack, parceljs and browserify in the [examples](https://github.com/ipfs/js-ipfs/tree/master/examples).\r\n\r\n## Want to hack on IPFS?\r\n\r\n[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\r\n\r\nThe IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:\r\n\r\nRead the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).\r\n\r\n- **Check out existing issues** The [issue list](https://github.com/ipfs/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge\r\n- **Perform code reviews** More eyes will help\r\n a. speed the project along\r\n b. ensure quality, and\r\n c. reduce possible future bugs.\r\n- **Add tests**. There can never be enough tests.\r\n\r\n## License\r\n\r\nLicensed under either of\r\n\r\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\r\n- MIT ([LICENSE-MIT](LICENSE-MIT) / )\r\n\r\n## Contribute\r\n\r\nContributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs/issues).\r\n\r\nAlso 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.\r\n\r\nPlease 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).\r\n\r\nUnless 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.\r\n\r\n[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\r\n","readmeFilename":"README.md"}
![\"IPFS](\"https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png\")
\r\n\r\n![](\"https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg\"){kind=icon}
\r\n![](\"https://david-dm.org/ipfs/js-ipfs.svg?style=flat&path=packages/ipfs-core\")
\r\n![](\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat\"){kind=icon}
\r\n![](\"https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat\"){kind=icon}
\r\n![](\"https://img.shields.io/badge/Node.js-%3E%3D10.0.0-orange.svg?style=flat\"){kind=icon}
\r\n![](\"https://img.shields.io/npm/dm/ipfs.svg\")
\r\n