An open API service indexing awesome lists of open source software.

https://github.com/ssbc/ssb-suggest-lite

SSB secret-stack plugin for fetching profiles of authors that match a name
https://github.com/ssbc/ssb-suggest-lite

Last synced: 5 months ago
JSON representation

SSB secret-stack plugin for fetching profiles of authors that match a name

Awesome Lists containing this project

README

          

# ssb-suggest-lite

> An SSB secret-stack plugin for fetching profiles of authors that match a name

This is a lighter and simpler variant of [ssb-suggest](https://github.com/ssbc/ssb-suggest) built with ssb-db2. The differences with ssb-suggest are:

- Supports only `ssb-db2`
- Can only answer queries about peers you follow and `defaultIds` (does not load the cache with "recent authors" nor "recent abouts")
- Does not contain the field `following` in the results

## Install

```
npm install ssb-suggest-lite
```

## Usage

- Requires **Node.js 6.5** or higher
- Requires `secret-stack@^6.2.0`
- Requires `ssb-db2` and the `aboutSelf` plugin
- Requires `ssb-friends@>=4.4.4`

```diff
SecretStack({appKey: require('ssb-caps').shs})
.use(require('ssb-master'))
+ .use(require('ssb-db2'))
+ .use(require('ssb-db2/about-self'))
+ .use(require('ssb-friends'))
.use(require('ssb-conn'))
.use(require('ssb-blobs'))
+ .use(require('ssb-suggest-lite'))
.call(null, config)
```

## API

`ssb.suggest.profile` works the same as with `ssb-suggest`, the only difference is that the results don't contain the field `following` nor the field `matchedName`.

## License

LGPL-3.0