Skip to content

Commit

Permalink
Merge pull request #26 from TrueSparrowSystems/branding-changes
Browse files Browse the repository at this point in the history
branding changes
  • Loading branch information
sunilkhedar authored Jan 30, 2023
2 parents bca6f31 + e037f66 commit 8218873
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 22 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## Slackmin v4.0.0
- Republished package under True Sparrow organisation.

## Slackmin v3.0.0
- Multi-workspace support added. Now the slack apps can be from different slack workspaces / domains.
- Validators functions exposed for easy integration with non Express frameworks like Koa, Fastify, etc.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The MIT License (MIT)
Copyright © 2022 PLG Works
Copyright © 2022 True Sparrow Systems Pvt. Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![Group 11088](https://user-images.githubusercontent.com/7627517/179924973-20755a21-db85-428c-9f25-a0b693d0ab87.png)

![npm version](https://img.shields.io/npm/v/@plgworks/slackmin.svg?style=flat)
![npm version](https://img.shields.io/npm/v/@truesparrow/slackmin.svg?style=flat)

Slackmin allows you to easily integrate slack [slash (/) commands](https://api.slack.com/interactivity/slash-commands), [interactive components](https://api.slack.com/interactivity/components), message formatting & custom modals in your Node.js application. You can build and setup custom tailored tools for your daily ops like different analytics reports, content management interfaces, customer support modules and much more. Also send alerts and notifications over Slack for your team to take actions on critical events in your application.

Expand Down Expand Up @@ -54,15 +54,15 @@ Keep a note of your App ID and Signing Secret from the "Basic Information" secti
## Install NPM

```shell script
npm install @plgworks/slackmin --save
npm install @truesparrow/slackmin --save
```

## Initialize
While using the package, create a singleton object of Slackmin and then use it across the application.
Example snippet for the Slackmin singleton object is given below.

```js
const Slackmin = require('@plgworks/slackmin');
const Slackmin = require('@truesparrow/slackmin');

const appConfigs = [
{
Expand Down Expand Up @@ -181,7 +181,7 @@ Validators are functions which expose the middleware functionality which can be
- Parameters: requestBody, requestRawBody, requestHeaders, decodedParams
- Description: This method can be used for implementing slash command middleware for slash command route.

Refer validators methods usage examples [here](https://github.com/PLG-Works/slackmin/tree/master/examples/koa)
Refer validators methods usage examples [here](https://github.com/TrueSparrowSystems/slackmin/tree/master/examples/koa)

## Interactive Components

Expand Down Expand Up @@ -421,13 +421,13 @@ On submission of the modal, the hidden parameters are obtained in the view submi

## Examples

We have added code snippets for all demo slackmin commands available on https://plgworks.com/slackmin
We have added code snippets for all demo slackmin commands available on https://truesparrow.com/slackmin

**1**. Refer [Express code snippets](https://github.com/PLG-Works/slackmin/tree/master/examples/express) to integrate Slackmin with [Express](https://expressjs.com/)<br>
**2**. Refer [Fastify code snippets](https://github.com/PLG-Works/slackmin/tree/master/examples/fastify) to integrate Slackmin with [Fastify](https://www.fastify.io/docs/latest/)<br>
**3**. Refer [Koa code snippets](https://github.com/PLG-Works/slackmin/tree/master/examples/koa) to integrate Slackmin with [Koa](https://koajs.com/)
**1**. Refer [Express code snippets](https://github.com/TrueSparrowSystems/slackmin/tree/master/examples/express) to integrate Slackmin with [Express](https://expressjs.com/)<br>
**2**. Refer [Fastify code snippets](https://github.com/TrueSparrowSystems/slackmin/tree/master/examples/fastify) to integrate Slackmin with [Fastify](https://www.fastify.io/docs/latest/)<br>
**3**. Refer [Koa code snippets](https://github.com/TrueSparrowSystems/slackmin/tree/master/examples/koa) to integrate Slackmin with [Koa](https://koajs.com/)

## Contribution
We welcome more helping hands to make Slackmin better. Feel free to report issues, raise PRs for fixes & enhancements.

<p align="left">Built with :heart: by <a href="https://plgworks.com/" target="_blank">PLG Works</a></p>
<p align="left">Built with :heart: by <a href="https://truesparrow.com/" target="_blank">True Sparrow</a></p>
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.0.0
4.0.0
2 changes: 1 addition & 1 deletion examples/express/slackmin.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// You can configure slack slash commands in different applications across same as well as multiple workspaces.
// Provide app configuration values here

const Slackmin = require('@plgworks/slackmin');
const Slackmin = require('@truesparrow/slackmin');
const appConfigs = [
{
id: '<slack_app1_id>',
Expand Down
2 changes: 1 addition & 1 deletion examples/fastify/slackmin.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// You can configure slack slash commands in different applications across same as well as multiple workspaces.
// Provide app configuration values here

const Slackmin = require('@plgworks/slackmin');
const Slackmin = require('@truesparrow/slackmin');
const appConfigs = [
{
id: '<slack_app1_id>',
Expand Down
2 changes: 1 addition & 1 deletion examples/koa/slackmin.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// You can configure slack slash commands in different applications across same as well as multiple workspaces.
// Provide app configuration values here

const Slackmin = require('@plgworks/slackmin');
const Slackmin = require('@truesparrow/slackmin');
const appConfigs = [
{
id: '<slack_app1_id>',
Expand Down
2 changes: 1 addition & 1 deletion lib/formatter/responseHelper.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*
* @module lib/formatter/response
*/
const Base = require('@plgworks/base'),
const Base = require('@truesparrow/base'),
responseHelper = new Base.responseHelper({
module_name: 'slackAdmin'
});
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@plgworks/slackmin",
"version": "3.0.0",
"name": "@truesparrow/slackmin",
"version": "4.0.0",
"description": "Easy integration to slack for sending messages, opening modals, interactive endpoints and much more.",
"main": "index.js",
"scripts": {
"pre-commit": "lint-staged"
},
"repository": {
"type": "git",
"url": "git+https://github.com/PLG-Works/slackmin.git"
"url": "git+https://github.com/TrueSparrowSystems/slackmin.git"
},
"keywords": [
"slackmin",
Expand All @@ -18,14 +18,14 @@
"slack modal",
"slack message"
],
"author": "PLG Works",
"author": "True Sparrow",
"license": "MIT",
"bugs": {
"url": "https://github.com/PLG-Works/slackmin/issues"
"url": "https://github.com/TrueSparrowSystems/slackmin/issues"
},
"homepage": "https://github.com/PLG-Works/slackmin#readme",
"homepage": "https://github.com/TrueSparrowSystems/slackmin#readme",
"dependencies": {
"@plgworks/base": "^1.0.0",
"@truesparrow/base": "^2.0.0",
"sanitize-html": "2.7.0",
"uuid": "8.3.2",
"@slack/bolt": "3.2.0",
Expand Down

0 comments on commit 8218873

Please sign in to comment.