6 Commits

Author SHA1 Message Date
cac6b9befa 2.0.3 2018-01-10 22:17:36 +01:00
a65815a83d docs(slack api): add links to slack's docs to README 2018-01-10 22:17:30 +01:00
9dce7ec37e 2.0.2 2018-01-10 22:12:24 +01:00
8992f1e879 update readme 2018-01-10 22:12:19 +01:00
f4bff3551e 2.0.1 2018-01-10 22:10:12 +01:00
c0b318cd73 feat(README): add synk badge 2018-01-10 22:10:09 +01:00
3 changed files with 5 additions and 5 deletions

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{
"name": "slackme",
"version": "2.0.0",
"version": "2.0.3",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

View File

@ -1,6 +1,6 @@
{
"name": "slackme",
"version": "2.0.0",
"version": "2.0.3",
"description": "API abstraction for mojoio",
"main": "dist/index.js",
"typings": "dist/index.d.ts",

View File

@ -14,9 +14,10 @@ API abstraction for mojoio
[![Dependency Status](https://david-dm.org/mojoio/slackme.svg)](https://david-dm.org/mojoio/slackme)
[![bitHound Dependencies](https://www.bithound.io/github/mojoio/slackme/badges/dependencies.svg)](https://www.bithound.io/github/mojoio/slackme/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/mojoio/slackme/badges/code.svg)](https://www.bithound.io/github/mojoio/slackme)
[![Known Vulnerabilities](https://snyk.io/test/npm/slackme/badge.svg)](https://snyk.io/test/npm/slackme)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
@ -31,7 +32,7 @@ mySlackme.sendMessage:{{
}, 'myAwesomeChannel'}
```
The message interface looks like this:
The message interface follows [Slack's docs (click here)](https://api.slack.com/docs/message-formatting) and looks like this:
```javascript
interface IAttachmentField {
@ -92,7 +93,6 @@ interface IMessageOptions {
Alternatively, there is the option of specifying a SlackMessage class
```javascript
const mySlackMessage = new SlackMessage({ /* message options here } */, mySlackme)
mySlackMessage.title = 'new Title' // modify message options
mySlackMessage.sendToRoom('general')