Skip to content

Commit 0f845fb

Browse files
committed
Update readme information
1 parent 98af18c commit 0f845fb

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# haskell-pebble
22

33
Run purescript-droplet migrations
4+
5+
## Usage
6+
7+
```
8+
pebble COMMAND
9+
10+
Available commands:
11+
define Export type definitions for table(s)
12+
```
13+
14+
`define` exports type definitions for table(s)
15+
16+
```
17+
pebble define [INPUT] [-s|--schema STRING]
18+
[-c|--connection-url STRING]
19+
[-f|--definitions-folder STRING]
20+
[-m|--module-base-name STRING]
21+
22+
Available options:
23+
-s,--schema STRING Database schema
24+
-c,--connection-url STRING
25+
Database connection URL
26+
-f,--definitions-folder STRING
27+
Folder to export type definitions
28+
-m,--module-base-name STRING
29+
Output module base name
30+
-h,--help Show this help text
31+
```

app/Main.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ optionsParser =
5656
( OA.strOption $
5757
OA.long "definitions-folder"
5858
<> OA.short 'f'
59-
<> OA.help "Folder to export typed definitions"
59+
<> OA.help "Folder to export type definitions"
6060
<> OA.metavar "STRING"
6161
)
6262
<*> OA.optional

0 commit comments

Comments
 (0)