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
Richard Littauer
617a68e10e
docs: Add note about community calls
...
This should close #394 , as we have moved the calls issues to that repository.
2018-07-25 12:32:39 -04:00
Richard Littauer
93ed9b9659
docs(README.md): Add Haja and Maintainer sponsors
...
This adds sponsors to the sponsor list.
2018-07-25 12:06:03 -04:00
V-V
e190c10710
Add Linux-specific installation details in README
...
Instructions for running examples only applied to MacOS. Rather than introducing
a new NPM dependency for running platform-specific commands, I thought it's
simpler to just have own scripts for each platform.
2018-04-17 11:29:31 +03:00
haad
4f7717cffd
Update the note in README on which platforms are supported
2018-03-27 16:33:07 +02:00
Max Visser
f462080c6e
Update README.md
2018-03-02 15:16:25 +01:00
Diana Thayer
b0d755f9bf
feat(core): add 'addDatabaseType' method for adding custom types
2018-01-16 08:04:12 -08:00
haad
02cc20c0c6
Update demo link in README
2018-01-06 10:45:11 +02:00
haad
f1b2f2252f
Exclude debug build from the npm package and add a note to README
2017-12-31 17:56:37 +02:00
haad
71457d0095
Change orbit-db to OrbitDB in readme
2017-12-31 09:45:05 +02:00
Haad
4c972822e4
Fix screenshot links in README
2017-12-26 11:56:19 +02:00
Ricardo J. Mendez
7cec03fcff
Fixing broken link for orbit-db-demo-3.gif
2017-12-24 08:42:16 +01:00
Ricardo J. Mendez
3b83f602cd
Dependency install notes were missing babel, webpack
2017-12-23 10:55:05 +01:00
haad
54bace5077
Add ecosystem modules to the README
2017-12-10 12:28:12 +01:00
haad
0773c22c48
Update documentation
2017-12-02 06:33:30 +01:00
haad
b8d99a561f
Add link to TodoMVC demo
2017-11-29 17:21:05 +01:00
haad
38da14db72
Add documentation about starting IPFS with pubsub enabled
2017-11-29 07:24:33 +01:00
haad
94dcc89053
Add CHANGELOG for 0.18.0 release
2017-11-28 14:47:46 +01:00
haad
42885b20a4
Write permissions for databases
...
Use latest store modules from npm
Update README
Update docs
Update examples
Update benchmarks
Update dependencies
Add Getting Started guide
Add new a screenshot
Add a new live demo
Add persistency tests for snapshot saving/loading and events
Add network stress tests (but skip them by default as they're very heavy and lengthy)
Add browser benchmarks
Add log() alias for eventlog() database
Add possibility to create database if it doesn't exist yet
Add support for orbitdb addresses
Add a test for starting replication when peers connect
Add debug build
Use IPFS nodeID as default user id
Use ipfs-pubsub-room
Handle closing of databases properly
Handle cache errors
Clean up tests, re-organize code files
Clean up code style
Support for CLI
Remove obsolete scripts
2017-11-28 09:10:51 +01:00
haad
abedd8dee6
Add CLI tool to the README
2017-09-18 09:11:01 +02:00
haad
aa5dd07470
We now have an IRC channel, #orbitdb on Freenode
2017-09-15 20:58:18 +02:00
Alex Werner
1ee248aee1
Fixed : 404 exemple link in readme.md
2017-06-28 03:06:56 +02:00
haad
f27973d16f
Update README
2017-03-31 11:53:01 +02:00
haad
cd5d726656
Add link to the live demo to README
2017-03-21 18:27:40 +01:00
haad
ba34e89484
Update README
2017-01-17 09:38:18 +01:00
haad
7a8439239e
Update README
2016-11-15 09:08:46 +01:00
haad
e46454beed
Update README
2016-11-02 13:50:15 +01:00
Haad
18c76d0edf
Update README.md
2016-10-17 13:02:52 +02:00
Richard Littauer
79643ef7fd
Add note about IRC and twitter
...
See #108
2016-10-14 10:32:48 -04:00
