Skip to content
This repository was archived by the owner on Mar 3, 2023. It is now read-only.

Commit 61bce44

Browse files
committed
DOC:update usage and feature
1 parent 8eb3c85 commit 61bce44

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

Diff for: README.md

+20-19
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ A file-based .env change notifier for your slack team.
2020

2121
## Features
2222

23-
- Update synchronization for .env file changes
23+
- Auto-sync .env file changes
24+
- Watch multiple .env files: .env, .env.test, .env.development, .env.production
2425
- Auto-post the update to slack channel as attachment
2526
- Basic metadata supported: timestamp, .env directory
26-
- Cross platform supported: Windows, Mac OS
27+
- Cross platform supported: Windows, Mac OS(intel, m1 chip)
2728

2829
## Install
2930

@@ -41,9 +42,7 @@ go build -o ./bin/owlly-for-mac owlly.go
4142
go build -o ./bin/owlly-for-window.exe owlly.go
4243
```
4344

44-
And execute the compiled file per platform.
45-
46-
Or, simply download binaries from [release](https://github.com/asunlabs/owlly/releases/tag/ver0.1.0) and execute it.
45+
Or, simply download binaries from [release](https://github.com/asunlabs/owlly/releases) and execute it.
4746

4847
## Prerequisite
4948

@@ -60,41 +59,43 @@ AUTHOR="developerasun"
6059
FOO="bar"
6160
SLACK_BOT_USER_OAUTH_TOKEN="xoxb-some-value-here"
6261
SLACK_CHANNEL_ID="channel-id-here"
63-
# OWLLY_DONE="true" # when update is done
62+
# OWLLY_DONE="true" // add this line when update is done
6463
```
6564

6665
## Usage
6766

68-
1. Run Owlly to watch .env changes.
69-
70-
```sh
71-
# if you cloned a repo,
72-
go run owlly.go
73-
74-
# if you executes .exe file,
75-
./owlly.exe
76-
```
77-
7867
1. Update .env as you wish.
7968

8069
```sh
8170
FOO="bar"
8271
```
8372

84-
1. Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
73+
2. Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
8574

8675
```sh
8776
# length of OWLLY_DONE > 0 ? send a DM : do nothing
8877
OWLLY_DONE="true"
8978
```
9079

80+
3. Run Owlly to watch .env changes.
81+
82+
```sh
83+
# if you cloned a repo,
84+
go run owlly.go
85+
86+
# if you executes binaries,
87+
./owlly-for-windows.exe
88+
./owlly-for-mac
89+
./owlly-for-mac-m1
90+
```
91+
9192
Check your slack channel if the message is sent.
9293

9394
**Note**
9495

95-
Owlly ver 0.1.0 does not support hot-reload yet. It means that you have to re-start Owlly in the situation where 1) you sent DM already 2) but updated it again 3) and want to send it again. Log will be printed but Slack API would not invoke in the case.
96+
Owlly ver 0.1.0 does not support hot-reload yet. It means that you have to re-start Owlly in the situation where 1) you sent DM already 2) but updated it again 3) and want to send it again.
9697

97-
## Contributor
98+
## Maintainer
9899

99100
Project Created by [developerasun](https://github.com/developerasun)
100101

0 commit comments

Comments
 (0)