Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,4 @@ ipfs/
models/database.sqlite3
src/test.js
src/core/ipfs/*
thinq/*
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Currently, the framework offers the following features:
The framework is created as an implementation of [the Idea](https://github.com/gnowledge/thinq_lib/blob/master/docs/conceptNote.md)

## Using the framework as a developer
You can install the leatest version on the package from the command line via
`npm install @gnowledge/thinq_lib`
You can also install it by adding the following line to package.json
`@gnowledge/thinq_lib: ^[version_number]`
For a detailed explanation of all the functions and APIs exposed by the framework, please check out the documentation [here](https://github.com/gnowledge/thinq_lib/tree/master/docs/core-api)

## Contributing to the framework
Expand All @@ -22,10 +26,12 @@ To start contributing to the framework as a developer, refer the docs [here](htt
- #### Version 0.2.0
* [ ] Add an option to include meta-data and extra information with service requests
* [ ] Allow a single Service Provider to provide multiple services if they like
* [ ] Add basic unit tests
- #### Other Plans
* [ ] Expand the framework to take advantage of all the features of the IPFS framework
* [ ] Support multiple layers and levels of encryption so that the developer can choose the appropriate one based on the requirements of the specific application being developed.
* [ ] The method for storing user ratings is currently pretty insecure, and a better way using blockchain should be implemented
* [ ] Add doc strings to the code so that new contributers find it easier to understand the code

## Examples
To find examples on how to build applications using this framework, please refer to [this repository](https://github.com/gnowledge/ThinQ-Examples).
2 changes: 1 addition & 1 deletion docs/core-api/thinQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* args (Object): The object retrned from the thinq.thinQ.init function

Returns:
* boolean: `true` if registration is sucessfull, `false` otherwise
* String: The unique string to identify every user. Works as your contact number

- #### thinq.thinQ.addUser(id, name, args)
> Add a user into your addressbook, so that you could refer to him not by their hash, but by human readable names that you enter
Expand Down
Loading