@seratch_/bolt-prisma - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
     "name": "@seratch_/bolt-prisma",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "Bolt for JavaScript Installation Store Extension - Prisma",
@@ -47,3 +47,3 @@ "main": "dist/index.js",
     },
-    "gitHead": "14c00dda9acce4164bbb83255d27e32482e49fc4"
+    "gitHead": "e2a0bc0dddb877fc9f98730462be860c578db8e4"
 }

README.md

@@ -1,6 +0,8 @@
-## Bolt for JavaScript Prisma Extension
+## Bolt for JavaScript: Prisma InstallationStore
 
+This module provides an `InstallationStore` implementation for [Prisma](https://www.prisma.io/) users.
+
 ### Getting Started
 
-#### Create a new project
+You can create a simple Node app project using the following `package.json` and `tsconfig.json`. Of course, if you would like to use some build tool such as [webpack](https://webpack.js.org/), you can go with your own way and add the necessary dependencies.
 
@@ -51,3 +53,3 @@ ##### package.json
 
-You can use the following App Manifest configuration for setting up a new app!
+The next step is to create a new Slack app configuration. You can use the following App Manifest configuration data for it.
 
@@ -77,2 +79,6 @@ ```yaml
 
+### Configure your Prisma schema
+
+The next step is to configure your Prisma schema.
+
 ##### prisma/schema.prisma
@@ -124,2 +130,4 @@
 
+You can setup a file-based database by running the following comamnds:
+
 ```bash
@@ -132,2 +140,6 @@ npm i
 
+### Place your source code in the project
+
+The last step is to add your code in the project and spin up your app. You can use the following code as-is.
+
 ##### src/index.ts
@@ -144,10 +156,3 @@
 
-const prismaClient = new PrismaClient({
-  log: [
-    {
-      emit: 'stdout',
-      level: 'query',
-    },
-  ],
-});
+const prismaClient = new PrismaClient({log: [{emit: 'stdout', level: 'query'}]});
 const installationStore = new PrismaInstallationStore({
@@ -197,5 +202,5 @@ // The name `slackAppInstallation` can be different
 
-#### Run the app
+Finally, your app is now available for running! Set all the required env variables, hit `npm start`, and then enable your public URL endpoint (you may want to use some proxy tool such as [ngrok](https://ngrok.com/)).
 
-```
+```bash
 export SLACK_CLIENT_ID=
@@ -209,1 +214,3 @@ export SLACK_CLIENT_SECRET=
 ```
+
+Now you can install the app into your Slack workspace from `https://{your public domain}/slack/install`. Enjoy!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36648

increased by2.76%

Number of lines in readme file

210

increased by3.45%

No dependency changes