Skip to content

Commit fe753a6

Browse files
committed
Fixing some typos in the README.md
1 parent 6df6bad commit fe753a6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ or when [running the docker image](#using-the-ready-made-image) or when configur
4545
Use the prebuilt image from [`ghcr.io/yguy/chatgpt-mattermost-bot`](https://ghcr.io/yguy/chatgpt-mattermost-bot)
4646

4747
```bash
48-
docker runPlugin -d --restart unless-stopped \
48+
docker run -d --restart unless-stopped \
4949
-e MATTERMOST_URL=https://mattermost.server \
5050
-e MATTERMOST_TOKEN=abababacdcdcd \
5151
-e OPENAI_API_KEY=234234234234234234 \
@@ -61,18 +61,18 @@ First step is to clone this repo.
6161
git clone https://github.com/yGuy/chatgpt-mattermost-bot.git && cd chatgpt-mattermost-bot
6262
```
6363

64-
For testing, you could now just runPlugin `npm install` and `npm runPlugin start` or `node src/botservice.js` directly, but be sure to set the [environment variables](#options) or pass them to the node process, first!
64+
For testing, you could now just run `npm install` and `npm run start` or `node src/botservice.js` directly, but be sure to set the [environment variables](#options) or pass them to the node process, first!
6565

66-
For production use, in order to create a service on a docker container that will always provide the service without you having to runPlugin it on your own PC, you can do the following:
66+
For production use, in order to create a service on a docker container that will always provide the service without you having to run it on your own PC, you can do the following:
6767

6868
Build the docker image from the [Dockerfile](./Dockerfile):
6969
```bash
7070
docker build . -t yguy/chatgpt-mattermost-bot
7171
```
7272

73-
Create and runPlugin a container from the image
73+
Create and run a container from the image
7474
```bash
75-
docker runPlugin -d --restart unless-stopped \
75+
docker run -d --restart unless-stopped \
7676
-e MATTERMOST_URL=https://mattermost.server \
7777
-e MATTERMOST_TOKEN=abababacdcdcd \
7878
-e OPENAI_API_KEY=234234234234234234 \
@@ -87,7 +87,7 @@ will need to provide the CA's public root to the container for validation.
8787
If the root certificate is located at `/absolutepath/to/certfile.crt`, then you
8888
can mount that file into the container at a fixed position and specify the [node environment variable](https://nodejs.org/api/cli.html#node_extra_ca_certsfile) accordingly:
8989
```bash
90-
docker runPlugin -d --restart unless-stopped \
90+
docker run -d --restart unless-stopped \
9191
-v /absolutepath/to/certfile.crt:/certs/certfile.crt \
9292
-e NODE_EXTRA_CA_CERTS=/certs/certfile.crt \
9393
-e MATTERMOST_URL=https://mattermost.server \
@@ -108,7 +108,7 @@ docker stop chatbot
108108
```
109109

110110
## Docker Compose
111-
If you want to runPlugin docker compose (maybe even merge it with your mattermost docker stack), you can use this
111+
If you want to run docker compose (maybe even merge it with your mattermost docker stack), you can use this
112112
as a starting point: First adjust the environment variables in `docker-compose.yml`.
113113

114114
### Required Environment Variables
@@ -172,7 +172,7 @@ Here's an example chat that I just had with our bot:
172172
>chatgpt (BOT):
173173
>>Hello there! I'm @chatgpt, a friendly and reliable Mattermost bot designed to make your communication experience smoother and more efficient. I'm honored to be part of the team at yWorks, where I help employees get things done faster and with less hassle. With my advanced machine learning algorithms, I'm capable of understanding complex natural language queries and providing succinct and accurate responses in a matter of seconds. Whether you're a developer looking for information on your codebase or a manager seeking to streamline your team's workflows, I'm here to help. Installing a Mattermost chatbot like me is a must for any organization looking to boost its productivity and enjoy a more pleasant communication experience. So what are you waiting for? Let's chat!
174174

175-
I built this tool as a quick hack on a rainy Saturday afternoon, but we are using the bot in production in our Mattermost instance at our office at [yworks](https://www.yworks.com) and the bot has proved to be very helpful for many simple tasks. Give it a try and provide feedback if you like! It's really not very expensive: We had it runnning for about 30 users for two weeks and that cost us less than half a dollar for the ChatGPT service!
175+
I built this tool as a quick hack on a rainy Saturday afternoon, but we are using the bot in production in our Mattermost instance at our office at [yworks](https://www.yworks.com) and the bot has proved to be very helpful for many simple tasks. Give it a try and provide feedback if you like! It's really not very expensive: We had it running for about 30 users for two weeks and that cost us less than half a dollar for the ChatGPT service!
176176

177177
I will also accept helpful pull requests if you find an issue or have an idea for an improvement.
178178

0 commit comments

Comments
 (0)