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

Commit 985fde7

Browse files
committed
DOC:change demo gif, update prerequisite
1 parent b4acc8c commit 985fde7

File tree

1 file changed

+27
-16
lines changed

1 file changed

+27
-16
lines changed

README.md

+27-16
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<div align="center">
2-
<img src="https://user-images.githubusercontent.com/83855174/200222357-3e74436c-36be-41f9-8da6-519052db15bf.png" alt="owlly banner" width="100%" />
2+
<img src="https://user-images.githubusercontent.com/83855174/200222357-3e74436c-36be-41f9-8da6-519052db15bf.png" alt="banner" width="100%" />
33
</div>
44

55
# 🦉 Owlly
66

7-
<img src="https://img.shields.io/badge/version-v0.1.3-red" alt="version 0.1.3" />
7+
<img src="https://img.shields.io/badge/version-v0.1.4-red" alt="version 0.1.4" />
88

99
A file-based .env change notifier for your slack team.
1010

11-
<img src="https://user-images.githubusercontent.com/83855174/198875029-f20bba16-66e6-48d2-9d06-9feaea8fe175.gif" height="400px" alt="owlly banner" width="100%" />
11+
<img src="https://user-images.githubusercontent.com/83855174/200312951-eec9e105-1772-4afa-b0ae-233d5fbda28d.gif" alt="demo" width="100%" />
1212

13-
## Contents
13+
## Table of Contents
1414

1515
- [Owlly](#owlly)
1616
- [Features](#features)
@@ -23,7 +23,7 @@ A file-based .env change notifier for your slack team.
2323
## Features
2424

2525
- Auto-sync .env file changes
26-
- Watch multiple .env files: .env, .env.test, .env.development, .env.production
26+
- Watch multiple .env files
2727
- Auto-post the update to slack channel as attachment
2828
- Basic metadata supported: timestamp, .env directory
2929
- Cross platform supported: Windows, Mac OS(intel, m1 chip)
@@ -48,6 +48,23 @@ Or, simply download binaries from [release](https://github.com/asunlabs/owlly/re
4848

4949
## Prerequisite
5050

51+
### Assumption
52+
53+
Owlly will check if below files exist in your project root and sync if exist.
54+
55+
```go
56+
envList = []string{
57+
".env",
58+
".env.test",
59+
".env.development",
60+
".env.production",
61+
".env.dev",
62+
".env.prod",
63+
}
64+
```
65+
66+
### Slack
67+
5168
In order to use Owlly, you have to
5269

5370
1. Create a slack bot
@@ -66,26 +83,20 @@ SLACK_CHANNEL_ID="channel-id-here"
6683

6784
## Usage
6885

69-
1. Make sure you have all .env files in project root
70-
71-
```
72-
.env, .env.test, .env.production, .env.development
73-
```
74-
75-
2. Update .env files as you wish.
86+
1. Update .env files as you wish.
7687

7788
```sh
7889
FOO="bar"
7990
```
8091

81-
3. Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
92+
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.
8293

8394
```sh
8495
# length of OWLLY_DONE > 0 ? send a DM : do nothing
8596
OWLLY_DONE="true"
8697
```
8798

88-
4. Run Owlly to watch .env changes.
99+
3. Run Owlly
89100

90101
```sh
91102
# if you cloned a repo,
@@ -97,9 +108,9 @@ go run owlly.go
97108
./owlly-for-mac-m1
98109
```
99110

100-
Check your slack channel if the message is sent. Result will look like below.
111+
Check your slack channel if the message is sent. Result will look like below.
101112

102-
<img src="hhttps://user-images.githubusercontent.com/83855174/198875580-ba52d111-907a-43bf-8937-23b5558378a4.png" height="400px" alt="owlly banner" width="100%" />
113+
<img src="https://user-images.githubusercontent.com/83855174/200310048-48d918c4-2478-4d60-a68a-906202b1a8db.png" height="400px" alt="owlly banner" width="100%" />
103114

104115
**Note**
105116

0 commit comments

Comments
 (0)