Commit Graph

131 Commits

Author SHA1 Message Date
Mark Henderson
910621d717 Adding rc2 to README 2019-04-09 09:46:48 -04:00
haad
d8f8a47768 Change the readme example code to use await 2019-04-03 08:14:41 +00:00
Haad
c7bbcf18ad Merge pull request #566 from orbitdb/feat/docs
Update docs
2019-04-03 08:08:42 +00:00
Richard Littauer
2545508e4b docs: Add FAQ section to README
This should make it more accessible.
2019-02-27 15:07:53 -05:00
shamb0t
6a137e3d92 Update docs 2019-02-20 14:36:38 +00:00
Richard Littauer
ba8ef59419 docs: remove await outside of an async function in example
See #549.
2019-02-08 21:14:34 -05:00
Chris Barber
3cf8b22540 minor readme formatting fix 2019-02-06 07:19:48 -08:00
Richard Littauer
0ac0d95324 Remove waffle mention in README 2019-02-05 12:10:19 -05:00
Richard Littauer
7321eb2890 Remove badges 2019-02-05 12:03:55 -05:00
shamb0t
44a97ba64e Merge pull request #552 from orbitdb/feat/contributing
docs: Reference the contributing guide
2019-01-30 12:08:26 +00:00
Richard Littauer
1b9f05a4b3 docs: Reference the contributing guide
Closes #517
2019-01-30 12:18:40 +02:00
shamb0t
0e312b6b18 Merge pull request #545 from Hazae41/patch-1
Changed ipfs to ipfs@0.33.0
2019-01-30 10:15:45 +00:00
Richard Littauer
86ededdac3 docs: remove freenode
Because we use Gitter now.
2019-01-30 10:57:52 +02:00
Richard Littauer
1b5474a60d Merge pull request #511 from orbitdb/feat/faq
Add an FAQ document
2019-01-28 14:11:20 +02:00
Haz
6af8f1f16b Update README.md 2019-01-22 14:32:47 +01:00
Mark Robert Henderson
53ea5ea426 Update README.md 2019-01-09 10:53:43 -05:00
Mark Robert Henderson
d96a36f08a Update README.md 2019-01-08 17:40:23 -05:00
Richard Littauer
b2a1c1e6b9 Use updated, smaller jpg 2019-01-04 16:22:41 -05:00
Richard Littauer
d139230680 Center image and badges 2019-01-04 16:16:49 -05:00
Richard Littauer
89f3fd34b0 Add logo and small style changes to README 2019-01-04 12:06:28 -05:00
Mark Robert Henderson
cf60bd17eb Update README.md to include node.js LTS preference 2019-01-04 11:26:46 -05:00
haad
5a5f828a09 Add project's status information and disclaimer to README 2018-12-14 14:45:04 +01:00
Haad
c2d1dec6c1 Merge pull request #510 from orbitdb/feat/code-of-conduct
docs: Add the Code of Conduct
2018-11-30 12:33:12 +02:00
Richard Littauer
2c7ca9e612 docs(README.md): Add note about calls above fold
In [at least this comment](https://github.com/orbitdb/orbit-db/issues/509#issuecomment-442710847), it was not clear that there were calls. This might help. What do you think?
2018-11-29 12:19:46 -05:00
Richard Littauer
b893ddc482 docs(README.md): npm should not be capitalized 2018-11-26 10:44:16 -05:00
Richard Littauer
44bf10bff8 docs: Add the Code of Conduct
The Code is already in orbitdb/welcome, but it has not been added to this repository yet. Doing so will mean that it is mentioned when people make PRs, and that it will be more visible to people coming to this repo.
2018-11-26 09:45:47 -05:00
0xflotus
a416469912 fixed specified 2018-09-16 23:04:56 +02:00
Richard Littauer
8342a8363e docs(README.md): Add a Gitter badge 2018-09-06 10:12:38 -04:00
Richard Littauer
b17d275af1 docs: update license information 2018-08-14 14:03:51 -04:00
Richard Littauer
8a9f0ec21d docs: Add TOCs using an npm script
This is a stab at making #426 work automatically, so that we don't need to manually adjust the files. I've also edited some of the depths of the headings. What do you think, @mistakia?

One thing I would like is to add this to the build. It shouldn't change anything if there are no changes to make.
2018-08-08 18:07:51 -04:00
Richard Littauer
11d7c32d1a Merge pull request #407 from mistakia/docs/update
Refactored README.md & updated API.md
2018-08-01 08:24:20 -04:00
Haad
d2f2d42955 Merge pull request #421 from orbitdb/feat/sponsors
docs(README.md): Add Haja and Maintainer sponsors
2018-08-01 12:38:03 +03:00
Kia Rahimian
2f84c96c9d docs: move custom store to GUIDE.md 2018-07-25 21:01:26 -04:00
Kia
3177f2c634 docs(readme): expand on usage with IPFS instance 2018-07-25 21:01:26 -04:00
Kia
51d0c2c3e9 docs(readme): remove api list
keep README.md concise
2018-07-25 21:01:26 -04:00
Kia
5585bff739 docs: fix typo 2018-07-25 21:01:26 -04:00
Kia Rahimian
a7ab7c4d4a docs: add store.load param 2018-07-25 21:01:26 -04:00
Kia
88ebe6a459 docs: fix styling 2018-07-25 21:01:26 -04:00
Kia
cbd03c0528 docs: refractor test demo links, remove duplicate links
remove duplicate info about GUIDE.md and CLI
2018-07-25 21:01:26 -04:00
Kia Rahimian
b045667cdd docs: add description for orbitdb.disconnect + update links 2018-07-25 21:01:26 -04:00
Kia Rahimian
a187f9ba69 docs: store cleanup 2018-07-25 21:01:26 -04:00
Kia Rahimian
41d7e24e5b docs: fix event links 2018-07-25 21:01:26 -04:00
Kia Rahimian
7d7b70f0fd docs: cleanup events 2018-07-25 21:01:26 -04:00
Kia Rahimian
7ce81d4913 docs(readme): refractor 2018-07-25 21:01:26 -04:00
Kia Rahimian
463fed966b docs(readme): update links 2018-07-25 21:01:26 -04:00
Kia Rahimian
e20b60ba3f docs(readme): refractor 2018-07-25 21:01:26 -04:00
Kia Rahimian
45f7e04f22 docs(readme): update store info 2018-07-25 21:01:25 -04:00
Kia Rahimian
4eed70b610 docs: cleanup 2018-07-25 21:01:25 -04:00
Kia Rahimian
680c0f35a2 docs: update links 2018-07-25 21:01:25 -04:00
Kia Rahimian
2c037a5236 docs: refractor 2018-07-25 21:01:25 -04:00