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

Commit 05eb3f3

Browse files
committed
chore: move docs around
1 parent c5474d0 commit 05eb3f3

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ We've come a long way, but this project is still in Alpha, lots of development i
2626

2727
## Getting started
2828

29-
Check our [examples folder](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser.
30-
29+
* Check our [examples folder](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser.
30+
* Read the [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) docs to see what you can do with an IPFS ndoe
31+
* Visit https://proto.school to learn how to use IPFS and the concepts that underpin it.
3132
## Tech Lead <!-- omit in toc -->
3233

3334
[David Dias](https://github.com/daviddias)

packages/ipfs-http-client/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,19 @@
2929

3030
> A client library for the IPFS HTTP API, implemented in JavaScript. This client library implements the IPFS [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/api) enabling applications to change between an embedded js-ipfs node and any remote IPFS node without having to change the code. In addition, this client library implements a set of utility functions.
3131
32+
## Getting started
33+
34+
* Check our [examples folder](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client/examples) to learn how to spawn an IPFS node in Node.js and in the Browser.
35+
* Read the [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) docs to see what you can do with an IPFS ndoe
36+
* Visit https://proto.school to learn how to use IPFS and the concepts that underpin it.
37+
3238
## Lead Maintainer
3339

3440
[Alex Potsides](http://github.com/achingbrain)
3541

3642
## Table of Contents
3743

44+
- [Getting started](#getting-started)
3845
- [Lead Maintainer](#lead-maintainer)
3946
- [Table of Contents](#table-of-contents)
4047
- [Install](#install)

packages/ipfs/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ We've come a long way, but this project is still in Alpha, lots of development i
3333

3434
## Getting started
3535

36-
Check our [examples folder](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser.
36+
* Check our [examples folder](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser.
37+
* Read the [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) docs to see what you can do with an IPFS ndoe
38+
* Visit https://proto.school to learn how to use IPFS and the concepts that underpin it.
3739

3840
## Tech Lead <!-- omit in toc -->
3941

@@ -50,6 +52,8 @@ Check our [examples folder](https://github.com/ipfs/js-ipfs/tree/master/examples
5052
- [Browser CDN](#browser-cdn)
5153
- [Browser bundle](#browser-bundle)
5254
- [Documentation](#documentation)
55+
- [Core API](#core-api)
56+
- [How to run IPFS in various environments](#how-to-run-ipfs-in-various-environments)
5357
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
5458
- [Packages](#packages)
5559
- [License](#license)
@@ -97,32 +101,32 @@ Learn how to bundle IPFS into your application with webpack, parceljs and browse
97101

98102
## Documentation
99103

100-
Core API:
104+
### Core API
101105

102106
* [API Docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
103107

104-
How to run IPFS in various environments:
108+
### How to run IPFS in various environments
105109

106110
* [docs/CLI.md](./docs/CLI.md)
107111
* [docs/DAEMON.md](./docs/DAEMON.md)
108112
* [docs/DOCKER.md](./docs/DOCKER.md)
109113

110-
How to use IPFS in your application:
114+
### How to use IPFS in your application
111115

112116
* [docs/MODULE.md](./docs/MODULE.md)
113117

114-
Different topics in detail:
118+
### Different topics in detail
115119

116120
* [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md)
117121
* [docs/MONITORING.md](./docs/MONITORING.md)
118122
* [docs/DELEGATE_ROUTERS.md](./docs/DELEGATE_ROUTERS.md)
119123
* [docs/DEVELOPMENT.md](./docs/DEVELOPMENT.md)
120124

121-
Questions?
125+
### Questions?
122126

123127
* [docs/FAQ.md](./docs/FAQ.md)
124128

125-
Need help?
129+
### Need help?
126130

127131
Please ask 'How do I?' questions on https://discuss.ipfs.io
128132

0 commit comments

Comments
 (0)