identifi-lib
Basic tools for reading, writing, indexing and searching Identifi messages and identities.
Usage
identifi = ;Gun = ; // github.com/amark/gun is needed; gun = 'https://identifi.herokuapp.com/gun' 'https://identifi2.herokuapp.com/gun';defaultIndexID = 'b8ByaYNBDCMLNdZqMdas5oUFLCxBf2VH3-NjUulDaTo.DVzINErRVs6m5tyjAux6fcNfndadcgZVN5hLSwYTCLc';user = gun; index = user;profile = index;profilegun;profile;
See plnkr.co example
for more.
Documentation
See the docs directory.
Installation
Install via yarn
yarn add identifi-lib (--dev)
or npm
npm install identifi-lib (--save-dev)
configuration
You can pass in extra options as a configuration object (➕ required, ➖ optional, ✏️ default).
;
➖ property ( type ) ✏️ default
📝 description
❗️ warning
ℹ️ info
💡 example
methods
#name
identifiLib
Examples
See example
folder or the runkit example.
Builds
If you don't use a package manager, you can access identifi-lib
via unpkg (CDN), download the source, or point your package manager to the url.
identifi-lib
is compiled as a collection of CommonJS modules & [ES2015 modules](http://www.2ality.com/2014/0
-9/es6-modules-final.html) for bundlers that support the jsnext:main
or module
field in package.json (Rollup, Webpack 2)
The identifi-lib
package includes precompiled production and development UMD builds in the dist
folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a <script>
tag on your page. The UMD builds make identifi-lib
available as a window.identifiLib
global variable.
License
The code is available under the MIT license.
Contributing
Please do integrate identifi-lib with your existing application or with a test application and create Github issues for the bugs and other problems you may encounter. Your help is much appreciated!
TODO list is also available on Trello.
Misc
This module was created using generator-module-boilerplate.