UNPKG

ms-users/README.md

Version:

1.5 kBMarkdownView Raw

1# Microservice for handling users over AMQP transport layer
2
3[![npm version](https://badge.fury.io/js/ms-users.svg)](https://badge.fury.io/js/ms-users)
4[![Build Status](https://semaphoreci.com/api/v1/projects/27a0c3e3-ba64-49e1-a1be-7655eae716b9/632945/shields_badge.svg)](https://semaphoreci.com/makeomatic/ms-users)
5[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
6[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
7[![codecov.io](https://codecov.io/github/makeomatic/ms-users/coverage.svg?branch=master)](https://codecov.io/github/makeomatic/ms-users?branch=master)
8[![Code Climate](https://codeclimate.com/github/makeomatic/ms-users/badges/gpa.svg)](https://codeclimate.com/github/makeomatic/ms-users)
9
10## Installation
11
12`npm i ms-users -S`
13
14## Overview
15
16Starts horizontally scalable nodejs worker communicating over amqp layer with redis cluster backend.
17Supports a broad range of operations for working with users. Please refer to the configuration options for now,
18that contains description of routes and their capabilities. Aims to provide a complete extendable solution to user's management.
19
20## Configuration
21
22TODO
23
24## Endpoint description
25
26Currently available on github pages
27
28## Docker images
29
30Built docker images are available: https://hub.docker.com/r/makeomatic/ms-users/

1	`# Microservice for handling users over AMQP transport layer`
2
3	`[![npm version](https://badge.fury.io/js/ms-users.svg)](https://badge.fury.io/js/ms-users)`
4	`[![Build Status](https://semaphoreci.com/api/v1/projects/27a0c3e3-ba64-49e1-a1be-7655eae716b9/632945/shields_badge.svg)](https://semaphoreci.com/makeomatic/ms-users)`
5	`[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)`
6	`[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)`
7	`[![codecov.io](https://codecov.io/github/makeomatic/ms-users/coverage.svg?branch=master)](https://codecov.io/github/makeomatic/ms-users?branch=master)`
8	`[![Code Climate](https://codeclimate.com/github/makeomatic/ms-users/badges/gpa.svg)](https://codeclimate.com/github/makeomatic/ms-users)`
9
10	`## Installation`
11
12	`npm i ms-users -S`
13
14	`## Overview`
15
16	`Starts horizontally scalable nodejs worker communicating over amqp layer with redis cluster backend.`
17	`Supports a broad range of operations for working with users. Please refer to the configuration options for now,`
18	`that contains description of routes and their capabilities. Aims to provide a complete extendable solution to user's management.`
19
20	`## Configuration`
21
22	`TODO`
23
24	`## Endpoint description`
25
26	`Currently available on github pages`
27
28	`## Docker images`
29
30	`Built docker images are available: https://hub.docker.com/r/makeomatic/ms-users/`