From ae79336d0ce7ddf67e5a73a15a4eb7683cd5ff73 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 26 Nov 2018 10:44:40 -0500 Subject: [PATCH] docs(FAQ.md): Touch FAQ and add introduction --- FAQ.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..1a1986b --- /dev/null +++ b/FAQ.md @@ -0,0 +1,7 @@ +# Frequently Asked Questions + +OrbitDB, like all code, is in a state of constant development. Doubtless, you're going to have some questions. The purpose of this FAQ is to answer the most common questions regarding how to get OrbitDB up and running, how to address common issues, and how to deal with pitfalls and common errors implementing it. + +This is a living document. If you see an answer that could be improved, please [open an issue](https://github.com/orbitdb/orbit-db/issues/new) or submit a PR directly. If you think than a question is missing, please [open an issue](https://github.com/orbitdb/orbit-db/issues/new). If you think that there is a better way to resolve a question - perhaps by improving the `orbitdb --help` docs or by adding a feature - please [open an issue](https://github.com/orbitdb/orbit-db/issues/new). Sense a theme yet? :) + +This document is seeded by questions from people opening issues in this repository. If enough people ask the same question, we'll add one here and point newcomers to it. Please don't be offended if the maintainers say "read the FAQ" - it's our way of making sure we don't spend all of our time answering the same questions.