This repository was archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: consolidate API docs and update readme files (#2944)
* docs: consolidate API docs and update readme files Moves api docs into `/docs` folder similarly to how js-libp2p has organised their docs. Tries to trim readmes down a bit to make them more digestible and adds links to futher information on different topics. Also reinstates dependency statuses. Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
- Loading branch information
1 parent
a2e0f2f
commit 10e8682
Showing
44 changed files
with
1,430 additions
and
1,625 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,9 +18,6 @@ node_modules | |
| # Build artefacts | ||
| dist | ||
|
|
||
| # Doc generation | ||
| docs | ||
|
|
||
| # Deployment files | ||
| .npmrc | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # Development <!-- omit in toc --> | ||
|
|
||
| - [Clone and install dependencies](#clone-and-install-dependencies) | ||
| - [Run tests](#run-tests) | ||
| - [Lint](#lint) | ||
| - [Build a dist version](#build-a-dist-version) | ||
| - [Publishing new versions](#publishing-new-versions) | ||
| - [Using prerelease versions](#using-prerelease-versions) | ||
|
|
||
| ## Clone and install dependencies | ||
|
|
||
| ```sh | ||
| > git clone https://github.com/ipfs/js-ipfs.git | ||
| > cd js-ipfs | ||
| > npm install | ||
| ``` | ||
|
|
||
| This will install [lerna](https://www.npmjs.com/package/lerna) and bootstrap the various packages, deduping and hoisting dependencies into the root folder. | ||
|
|
||
| If later you add new dependencies to submodules or just wish to remove all the `node_modules`/`dist` folders and start again, run `npm run reset && npm install` from the root. | ||
|
|
||
| See the scripts section of the root [`package.json`](./package.json) for more commands. | ||
|
|
||
| ## Run tests | ||
|
|
||
| ```sh | ||
| # run all the unit tests | ||
| > npm test | ||
|
|
||
| # run just IPFS tests in Node.js | ||
| > npm run test:node | ||
|
|
||
| # run just IPFS tests in a browser | ||
| > npm run test:browser | ||
|
|
||
| # run just IPFS tests in a webworker | ||
| > npm run test:webworker | ||
| ``` | ||
|
|
||
| More granular test suites can be run from each submodule. | ||
|
|
||
| Please see the `package.json` in each submodule for available commands. | ||
|
|
||
| ## Lint | ||
|
|
||
| Please run the linter before submitting a PR, the build will not pass if it fails: | ||
|
|
||
| ```sh | ||
| > npm run lint | ||
| ``` | ||
|
|
||
| ## Build a dist version | ||
|
|
||
| ```sh | ||
| > npm run build | ||
| ``` | ||
|
|
||
| ## Publishing new versions | ||
|
|
||
| 1. Ensure you have a `GH_TOKEN` env var containing a GitHub [Personal Access Token](https://github.com/settings/tokens) with `public_repo` permissions | ||
| 2. From the root of this repo run `npm run release` and follow the on screen prompts. It will use [conventional commits](https://www.conventionalcommits.org) to work out the new package version | ||
|
|
||
| ## Using prerelease versions | ||
|
|
||
| Any changed packages from each successful build of master are published to npm as canary builds under the npm tag `next`. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # IPFS module <!-- omit in toc --> | ||
|
|
||
| These are functions not in the [Core API](#core-api) but that are specific to [`ipfs`](../packages/ipfs). | ||
|
|
||
| ## Table of contents <!-- omit in toc --> | ||
|
|
||
| - [Constructor](#constructor) | ||
| - [`options.repo`](#optionsrepo) | ||
| - [`options.repoAutoMigrate`](#optionsrepoautomigrate) | ||
| - [`options.init`](#optionsinit) | ||
| - [`options.start`](#optionsstart) | ||
| - [`options.pass`](#optionspass) | ||
| - [`options.silent`](#optionssilent) | ||
| - [`options.relay`](#optionsrelay) | ||
| - [`options.offline`](#optionsoffline) | ||
| - [`options.preload`](#optionspreload) | ||
| - [`options.EXPERIMENTAL`](#optionsexperimental) | ||
| - [`options.config`](#optionsconfig) | ||
| - [`options.ipld`](#optionsipld) | ||
| - [`options.libp2p`](#optionslibp2p) | ||
| - [`options.connectionManager`](#optionsconnectionmanager) | ||
| - [Instance methods](#instance-methods) | ||
| - [`node.start()`](#nodestart) | ||
| - [`node.stop()`](#nodestop) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # IPFS Docs <!-- omit in toc --> | ||
|
|
||
| - [API Docs](#api-docs) | ||
| - [How tos and other documentation](#how-tos-and-other-documentation) | ||
| - [Development documentation](#development-documentation) | ||
|
|
||
| ## API Docs | ||
|
|
||
| `ipfs` can run as part of your program (an in-process node) or as a standalone daemon process that can be communicated with via an HTTP RPC API using the [`ipfs-http-client`](../packages/ipfs-http-api) module. | ||
|
|
||
| Whether accessed directly or over HTTP, both methods support the full [Core API](#core-api). In addition other methods are available to construct instances of each module, etc. | ||
|
|
||
| * [Core API docs](./core-api/README.md) | ||
| * [IPFS API](../packages/ipfs/README.md) | ||
| * [IPFS-HTTP-CLIENT API](../packages/ipfs-http-client/README.md) | ||
|
|
||
| ## How tos and other documentation | ||
|
|
||
| * [How to run js-IPFS in the browser](./BROWSERS.md) | ||
| * [js-IPFS configuration options](./CONFIG.md) | ||
|
|
||
| ## Development documentation | ||
|
|
||
| * [Release issue template](./RELEASE_ISSUE_TEMPLATE.md) | ||
| * [Early testers](./EARLY_TESTERS.md) | ||
| * [Releases](./RELEASES.md) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.