From 2545508e4b4f330beac13e48a6b98e9cebcf37e0 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Wed, 27 Feb 2019 15:07:53 -0500 Subject: [PATCH] docs: Add FAQ section to README This should make it more accessible. --- FAQ.md | 2 +- README.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/FAQ.md b/FAQ.md index b6996d3..a542e21 100644 --- a/FAQ.md +++ b/FAQ.md @@ -15,7 +15,7 @@ This document is seeded by questions from people opening issues in this reposito - [Is every `put` to OrbitDB immediately sent to the network and persisted?](#is-every-put-to-orbitdb-immediately-sent-to-the-network-and-persisted) - [Does OrbitDB already support pinning when using js-ipfs ?](#does-orbitdb-already-support-pinning-when-using-js-ipfs-) - [Does orbit have a shared feed between peers where multiple peers can append to the same feed?](#does-orbit-have-a-shared-feed-between-peers-where-multiple-peers-can-append-to-the-same-feed) -- [Contribute](#contribute) +- [How can I contribute to this FAQ?](#how-can-i-contribute-to-this-faq) diff --git a/README.md b/README.md index 45d6e4b..57dd102 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ We also have regular community calls, which we announce in the issues in [the @o * [Build](#build) * [Benchmark](#benchmark) * [Logging](#logging) +- [Frequently Asked Questions](#frequently-asked-questions) - [Contributing](#contributing) - [Sponsors](#sponsors) - [License](#license) @@ -259,6 +260,10 @@ To enable OrbitDB's logging output, set a global ENV variable called `LOG` to `d LOG=debug node ``` +## Frequently Asked Questions + +We have an FAQ! [Go take a look at it](FAQ.md). If a question isn't there, open an issue and suggest adding it. We can work on the best answer together. + ## Contributing **Take a look at our organization-wide [Contributing Guide](https://github.com/orbitdb/welcome/blob/master/contributing.md).** You'll find most of your questions answered there. Some questions may be answered in the [FAQ](FAQ.md), as well.