Merge 5ccf273 into 3a83fc1

docs-home.md

@@ -0,0 +1,27 @@
+# Getting started
+
+```bash
+git clone https://github.com/maidsafe/safe_app_nodejs.git
+```
+```bash
+cd safe_app_nodejs
+```
+```bash
+yarn
+```
+```javascript
+const safe = require('@maidsafe/safe-node-app');
+const appInfo = {
+    id     : 'net.maidsafe.example',
+    name   : 'Example SAFE app',
+    vendor : 'MaidSafe.net Ltd'
+};
+const asyncFn = async () => {
+    const app = await safe.{@link initialiseApp}(appInfo);
+};
+```
+
+**Recommended to build [basic Electron app](https://github.com/maidsafe/safe_examples/tree/master/safe_app_electron_quick_start), while referencing this documentation.**
+
+Our web API exposed in [SAFE Browser](https://github.com/maidsafe/safe_browser), nearly identical to this library with just one variation, is an easy way to start exploring operations.
+Recommended to either follow the [web API tutorial](https://github.com/maidsafe/safe_examples/tree/master/safe_web_app_quick_start) or to explore with our [web API playground](https://github.com/maidsafe/safe_examples/tree/master/safe_web_api_playground).

jsdoc-template/LICENSE.md

@@ -0,0 +1,81 @@
+Modifications Copyright 2018 MaidSafe.net Limited
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+# Third-Party Software
+
+This JSDoc template includes or depends upon the following third-party software, either in
+whole or in part. Each third-party software package is provided under its own
+license.
+
+# Docdash
+
+Docdash is free software, licensed under the Apache License, Version 2.0 (the
+"License"). Commercial and non-commercial use are permitted in compliance with
+the License.
+
+Copyright (c) 2016 Clement Moron <clenemt@gmail.com> and the
+[contributors to docdash](https://github.com/clenemt/docdash/graphs/contributors).
+All rights reserved.
+
+You may obtain a copy of the License at:
+http://www.apache.org/licenses/LICENSE-2.0
+
+In addition, a copy of the License is included with this distribution.
+
+As stated in Section 7, "Disclaimer of Warranty," of the License:
+
+> Licensor provides the Work (and each Contributor provides its Contributions)
+> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+> express or implied, including, without limitation, any warranties or
+> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+> PARTICULAR PURPOSE. You are solely responsible for determining the
+> appropriateness of using or redistributing the Work and assume any risks
+> associated with Your exercise of permissions under this License.
+
+The source code for docdash is available at:
+https://github.com/clenemt/docdash
+
+# Third-Party Software
+
+Docdash includes or depends upon the following third-party software, either in
+whole or in part. Each third-party software package is provided under its own
+license.
+
+## JSDoc 3
+
+JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
+"License"). Commercial and non-commercial use are permitted in compliance with
+the License.
+
+Copyright (c) 2011-2016 Michael Mathews <micmath@gmail.com> and the
+[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
+All rights reserved.
+
+You may obtain a copy of the License at:
+http://www.apache.org/licenses/LICENSE-2.0
+
+In addition, a copy of the License is included with this distribution.
+
+As stated in Section 7, "Disclaimer of Warranty," of the License:
+
+> Licensor provides the Work (and each Contributor provides its Contributions)
+> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+> express or implied, including, without limitation, any warranties or
+> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+> PARTICULAR PURPOSE. You are solely responsible for determining the
+> appropriateness of using or redistributing the Work and assume any risks
+> associated with Your exercise of permissions under this License.
+
+The source code for JSDoc 3 is available at:
+https://github.com/jsdoc3/jsdoc