skellington-welcome

A Skellington plugin to DM a user with a welcome message.

Usage

Initialize the plugin with a config containing your welcome text:

require('skellington')({
  plugins: [
    require('skellington-welcome')({text: 'Welcome to our awesome Slack team!'})
  ]}
);

When a new users joins your team, your Skellington bot will DM them with your message.

Using a Welcome Post

Instead of a plain text welcome message you can also upload a post. Posts can include markdown, so this option is nice if you want a richer message.

require('skellington')({
  plugins: [
    require('skellington-welcome')({
      type: 'post',
      title: 'Hey there cool person', // optional, defaults to "Welcome"
      text: fs.readFileSync('welcome.md')
    })
  ]
});

Help

Just DM your bot with welcome and it will reply with the welcome text.