Skip to content

Commit 42a446f

Browse files
committed
Revise README command sections and add links
Improved organization and clarity of command documentation by adding icons, section dividers, and consistent formatting. Updated project footer with GitHub and website links.
1 parent 93e44f3 commit 42a446f

1 file changed

Lines changed: 38 additions & 24 deletions

File tree

README.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -104,109 +104,121 @@ envdoc sync .env .env.staging .env.production
104104

105105
### Commands
106106

107-
#### Documentation & Schema Generation
107+
#### 📚 Documentation & Schema Generation
108108

109-
**Create Example File**
109+
##### Create Example File
110110
```bash
111111
envdoc create-example [file] [output]
112112
```
113113
Generates an example file with empty values based on keys in the source file.
114114

115-
**Create JSON Schema**
115+
##### Create JSON Schema
116116
```bash
117117
envdoc create-schema [file] [output]
118118
```
119119
Generates a JSON schema defining all environment variables.
120120

121-
#### File Management
121+
-----------------------------------------------------------------------
122122

123-
**Arrange**
123+
#### 📑 File Management
124+
125+
##### Arrange
124126
```bash
125127
envdoc arrange [file]
126128
```
127129
Sorts and groups environment variables alphabetically.
128130

129-
**Sync**
131+
##### Sync
130132
```bash
131133
envdoc sync [file1] [file2] [fileN...]
132134
```
133135
Synchronizes keys across multiple files, adding missing keys with empty values.
134136

135-
#### Auditing & Comparison
137+
-----------------------------------------------------------------------
138+
139+
#### 🔍 Auditing & Comparison
136140

137-
**Audit**
141+
##### Audit
138142
```bash
139143
envdoc audit [file]
140144
```
141145
Generates a report of duplicate keys in a file.
142146

143-
**Compare**
147+
##### Compare
144148
```bash
145149
envdoc compare [file1] [file2] [fileN...]
146150
```
147151
Generates a comparison report showing missing keys across files.
148152

149-
**Doctor**
153+
##### Doctor
150154
```bash
151155
envdoc doctor
152156
```
153157
Audits all .env files in the current directory.
154158

155-
**Engineer**
159+
#### Engineer
156160
```bash
157161
envdoc engineer
158162
```
159163
Synchronizes and arranges all .env files in the current directory.
160164

161-
#### Validation
165+
-----------------------------------------------------------------------
162166

163-
**Validate**
167+
#### 📝 Validation
168+
169+
##### Validate
164170
```bash
165171
envdoc validate [file] [schema-file]
166172
```
167173
Validates a .env file against a JSON schema.
168174

169-
#### Conversion
175+
-----------------------------------------------------------------------
176+
177+
#### 🔄 Conversion
170178

171-
**Convert To**
179+
##### Convert To
172180
```bash
173181
envdoc to [json|yaml] [file]
174182
```
175183
Converts .env file to JSON or YAML format.
176184

177-
**Convert From**
185+
##### Convert From
178186
```bash
179187
envdoc from [file]
180188
```
181189
Converts JSON or YAML file to .env format.
182190

183-
#### Security
191+
-----------------------------------------------------------------------
184192

185-
**Encrypt**
193+
#### 🔐 Security
194+
195+
##### Encrypt
186196
```bash
187197
envdoc encrypt [file]
188198
```
189199
Encrypts a file using AES-256-CBC with PBKDF2 key derivation.
190200

191-
**Decrypt**
201+
##### Decrypt
192202
```bash
193203
envdoc decrypt [file]
194204
```
195205
Decrypts an encrypted file.
196206

197-
**Hash**
207+
##### Hash
198208
```bash
199209
envdoc hash [file]
200210
```
201211
Generates and displays SHA256 hash of a file.
202212

203-
**Base64**
213+
##### Base64
204214
```bash
205215
envdoc base64 [encode|decode] [file]
206216
```
207217
Encodes or decodes a file using base64.
208218

209-
#### Information
219+
-----------------------------------------------------------------------
220+
221+
#### ℹ️ Information
210222

211223
```bash
212224
envdoc version # Show version
@@ -216,6 +228,8 @@ envdoc changelog # Show changelog
216228
envdoc authors # Show authors
217229
```
218230

231+
-----------------------------------------------------------------------
232+
219233
## 📖 Examples
220234

221235
### Example 1: Project Setup
@@ -373,7 +387,7 @@ Example:
373387
```
374388
Title: envdoc sync fails with special characters in keys
375389
376-
Description: When syncing files with keys containing special characters like '@' or '$',
390+
Description: When syncing files with keys containing special characters like '@' or '$',
377391
the command crashes with a parse error.
378392
379393
Steps to reproduce:
@@ -434,4 +448,4 @@ If you find envdoc helpful, please give it a star on GitHub!
434448

435449
---
436450

437-
**Made with ❤️ by MayR Labs** | [GitHub](https://github.com/MayR-Labs)
451+
**Made with ❤️ by MayR Labs** | [GitHub @MayR-Labs](https://github.com/MayR-Labs) | [Website (mayrlabs.com)](https://mayrlabs.com)

0 commit comments

Comments
 (0)