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

Commit c9ae168

Browse files
DOC: add banner
1 parent 5b26278 commit c9ae168

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
<img src="https://img.shields.io/badge/version-v0.1.0-red" alt="version 0.1.0" />
1+
<div align="center">
2+
<img src="https://user-images.githubusercontent.com/83855174/200222357-3e74436c-36be-41f9-8da6-519052db15bf.png" alt="owlly banner" width="100%" />
3+
</div>
24

3-
# Owlly
5+
# 🦉 Owlly
46

5-
A file-based .env change notifier for your slack team.
7+
<img src="https://img.shields.io/badge/version-v0.1.3-red" alt="version 0.1.3" />
68

7-
![owlly-intro](https://user-images.githubusercontent.com/83855174/198875029-f20bba16-66e6-48d2-9d06-9feaea8fe175.gif)
9+
A file-based .env change notifier for your slack team.
810

9-
![owlly-result](https://user-images.githubusercontent.com/83855174/198875580-ba52d111-907a-43bf-8937-23b5558378a4.png)
11+
<img src="https://user-images.githubusercontent.com/83855174/198875029-f20bba16-66e6-48d2-9d06-9feaea8fe175.gif" height="400px" alt="owlly banner" width="100%" />
1012

1113
## Contents
1214

@@ -15,7 +17,7 @@ A file-based .env change notifier for your slack team.
1517
- [Install](#install)
1618
- [Prerequisite](#prerequisite)
1719
- [Usage](#usage)
18-
- [Contributor](#contributor)
20+
- [Maintainer](#maintainer)
1921
- [Reference](#reference)
2022

2123
## Features
@@ -64,20 +66,26 @@ SLACK_CHANNEL_ID="channel-id-here"
6466

6567
## Usage
6668

67-
1. Update .env as you wish.
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.
6876

6977
```sh
7078
FOO="bar"
7179
```
7280

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.
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.
7482

7583
```sh
7684
# length of OWLLY_DONE > 0 ? send a DM : do nothing
7785
OWLLY_DONE="true"
7886
```
7987

80-
3. Run Owlly to watch .env changes.
88+
4. Run Owlly to watch .env changes.
8189

8290
```sh
8391
# if you cloned a repo,
@@ -89,11 +97,13 @@ go run owlly.go
8997
./owlly-for-mac-m1
9098
```
9199

92-
Check your slack channel if the message is sent.
100+
Check your slack channel if the message is sent. Result will look like below.
101+
102+
<img src="hhttps://user-images.githubusercontent.com/83855174/198875580-ba52d111-907a-43bf-8937-23b5558378a4.png" height="400px" alt="owlly banner" width="100%" />
93103

94104
**Note**
95105

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.
106+
- Owlly ver 0.1.3 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.
97107

98108
## Maintainer
99109

0 commit comments

Comments
 (0)