Skip to content

Commit b0b21df

Browse files
Update README.md (#3)
1 parent ec2e891 commit b0b21df

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,29 @@
2525

2626
## Usage
2727

28-
**IMPORTANT:** Create a `notgitmodules.yaml` file in your project's root directory.
28+
1. **IMPORTANT:** Create a `notgitmodules.yaml` file in your project's root directory.
2929

30-
1. **Example with Code**:
30+
```yaml
31+
repos:
32+
# directory: url (ssh or https)
3133

32-
Create a `notgitmodules.yaml` file:
34+
# Example
35+
file_reader: https://github.com/Free-Apps-for-All/file_manager_git_module
36+
```
3337
34-
```yaml
35-
repos:
36-
# directory: url (ssh or https)
3738
38-
# Example
39-
file_reader: https://github.com/Free-Apps-for-All/file_manager_git_module
40-
```
39+
2. Let `not_gitmodules` do the job.
4140

42-
Then pass the path to the `initializer` function:
41+
- **Example with Code**:
4342

43+
Pass the path to the `initializer` function:
4444
```python
4545
from not_gitmodules import initializer
4646
4747
initializer('/path/to/notgitmodules.yaml')
4848
```
4949

50-
2. **Example with CLI**:
50+
- **Example with CLI**:
5151

5252
Install the library locally if you cloned the repo:
5353

@@ -58,7 +58,7 @@
5858
Once installed, you can delete the local repo from your system (the library is now saved in the virtual environment
5959
or globally).
6060

61-
Run `not_gitmodules` directly from the terminal:
61+
Run the `not_gitmodules` command directly from the terminal:
6262

6363
```bash
6464
not_gitmodules

0 commit comments

Comments
 (0)