Skip to content

Commit 550c58f

Browse files
committed
Installation instructions are more complete
1 parent 099bc9d commit 550c58f

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed

README.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,40 @@ For more information, see:
1212

1313
[https://github.com/message-db/message-db](https://github.com/message-db/message-db)
1414

15-
## Documentation
16-
17-
See the Message DB documentation on the Eventide docs site:
18-
19-
[http://docs.eventide-project.org/user-guide/message-db/](http://docs.eventide-project.org/user-guide/message-db/)
20-
21-
## License
22-
23-
The `message-db` library is released under the [MIT License](https://github.com/message-db/npm-module/blob/master/MIT-License.txt).
24-
25-
26-
15+
## Installation
2716

17+
``` bash
18+
npm install @eventide/message-db
19+
```
2820

21+
## Create the Postgres Database
2922

23+
Running the database installation tool creates the database, schema, table, indexes, functions, views, types, a user role, and limit the user's privileges to the message store's public interface.
3024

25+
**Note: Make sure that your default Postgres user has administrative privileges.**
3126

27+
To execute the update script, navigate to the directory where the `message-db` module is installed and run the script:
3228

33-
xxxxxxxxxxxxxxxx
29+
``` bash
30+
install.sh
31+
```
3432

35-
# Postgres Message Store Database
33+
### Database Name
3634

37-
Database definition and tools for PostgreSQL message store
35+
By default, the database creation tool will create a database named `message_store`.
3836

39-
## Installation
37+
If you prefer either a different database name, you can override the name using the `DATABASE_NAME` environment variable.
4038

4139
``` bash
42-
npm install @eventide/postgres-message-store
40+
DATABASE_NAME=some_other_database install.sh
4341
```
4442

4543
## Documentation
4644

47-
See the message store documentation on the Eventide docs site:
48-
49-
[http://docs.eventide-project.org/user-guide/message-store/](http://docs.eventide-project.org/user-guide/message-store/)
50-
51-
## Database Definition Script Files
52-
53-
The database is defined by raw SQL scripts. You can examine them, or execute them directly with the `psql` command line tool.
45+
See the Message DB documentation on the Eventide docs site:
5446

55-
[https://github.com/eventide-project/postgres-message-store-database/tree/master/database/](https://github.com/eventide-project/postgres-message-store-database/tree/master/database/)
47+
[http://docs.eventide-project.org/user-guide/message-db/](http://docs.eventide-project.org/user-guide/message-db/)
5648

5749
## License
5850

59-
The `Postgres Message Store Database` library is released under the [MIT License](https://github.com/eventide-project/postgres-message-store-npm-package/blob/master/MIT-License.txt).
51+
The `message-db` library is released under the [MIT License](https://github.com/message-db/npm-module/blob/master/MIT-License.txt).

0 commit comments

Comments
 (0)