moar docs

Author: sevenbitbyte

README.md

@@ -1,13 +1,87 @@
 # @dataparty/api
 [![experimental](http://badges.github.io/stability-badges/dist/experimental.svg)](http://github.com/badges/stability-badges)[![license](https://img.shields.io/github/license/datapartyjs/api)](https://github.com/datapartyjs/dataparty-api/blob/master/LICENSE)
 
-@dataparty/api is an ad-hoc cloud solution for the Web3.0 generation.
+ad-hoc cloud for the Web3.0 generation
 
  * Documentation - [datapartyjs.github.io/dataparty-api](https://datapartyjs.github.io/dataparty-api)
  * NPM - [npmjs.com/package/@dataparty/api](https://www.npmjs.com/package/@dataparty/api)
  * Code - [github.com/datapartyjs/dataparty-api](https://github.com/datapartyjs/dataparty-api)
  * Support - [ko-fi/dataparty](https://ko-fi.com/dataparty)
 
-# Goals
+## Goals
 
-The primary goal of @dataparty/api is to push 
+The primary goal of `@dataparty/api` is to enable secure microservices development across all architectual domains with a single code base. This covers traditional clouds, peer-to-peer apps(with or without cloud backing), and hybrid clouds.
+
+
+
+## Roadmap
+
+Currently this project is considered `Experimental`, throughout 2023 we'll be working towards our first stable releases.
+
+![Feature Roadmap 2023](images/dataparty-overivew-full.svg)
+
+
+
+## Example
+
+```
+
+const Dataparty = require('@dataparty/api')
+
+
+async function getUser(name) {
+  return (await local.find()
+    .type('user')
+    .where('name').equals(name)
+    .exec())[0]
+}
+
+
+async function main(){
+  const dbPath = (await fs.mkdtemp('/tmp/loki-party')) + '/loki.db'
+
+  debug('db location', dbPath)
+
+  local = new Dataparty.LokiParty({
+    path: dbPath,
+    model: MyServiceModel,
+    config: new Dataparty.Config.MemoryConfig()
+  })
+
+
+  await local.start()
+
+  let user = await getUser('tester')
+
+  
+  if(!user){
+    debug('creating document')
+    user = await local.createDocument('user', {name: 'tester', created: (new Date()).toISOString() })
+  }
+  else{
+    debug('loaded document')
+  }
+
+  console.log(user.data)
+
+
+  user.data.name = 'renamed-tester'
+
+  await user.save()
+
+  console.log(user.data)
+
+  let userFind = await getUser('renamed-tester')
+
+  console.log(userFind)
+
+
+  console.log(dbPath)
+
+
+  await user.remove()
+
+  console.log(await getUser('renamed-tester'))
+
+}
+```

images/dataparty-overivew-full.svg

@@ -4,8 +4,7 @@ const JsonFileConfig = require('./json-file')
 const LocalStorageConfig = require('./local-storage')
 
 /**
- * Config
- * @namespace Config
+ * @module Config
  */
 const Config = {
   NconfConfig,

src/config/index.js

@@ -10,9 +10,12 @@ const logger = require('debug')('dataparty.config.json-file')
 const IConfig = require('./iconfig')
 
 /**
- * @class Config.JsonFileConfig
+ * @module Config
+ */
+
+/**
+ * @class
  * @implements {IConfig}
- * @namespace Config
  */
 class JsonFileConfig extends IConfig {