Skip to content

Commit eb57a76

Browse files
authored
New documentation for v1.1.2
A revised documentation has been added to the repo with updated guidelines
2 parents 6fc9460 + 23360ae commit eb57a76

File tree

1 file changed

+6
-15
lines changed

1 file changed

+6
-15
lines changed

DOCUMENTATION.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by
6868

6969
### Adding a new repo
7070
- Use "+" at the bottom right corner to add a repo.
71-
![add-a-repo](https://user-images.githubusercontent.com/65342122/87232632-0eff7480-c3de-11ea-8a9f-f0a6cf9cd6ee.png)<!-- .element style="height:10%; width:10%" -->
71+
![add-a-repo](https://user-images.githubusercontent.com/65342122/88536126-db9d2680-d028-11ea-890f-c5fc11cd7cf0.png)
7272

7373
- Enter repo name and paste the repo path. If the folder is not a git repo then check the "*Check this if the folder is not a git repo*" checkbox to initialize git.
74-
![repo-details](https://user-images.githubusercontent.com/65342122/87232637-16268280-c3de-11ea-9f9d-708c5a3eb668.png)
74+
![repo-details](https://user-images.githubusercontent.com/65342122/88486721-70f2d900-cf9d-11ea-802d-00b0b2aaf638.png)
7575

7676
- The newly added repo will be displayed as a card in the dashboard
7777
![repo-card](https://user-images.githubusercontent.com/65342122/87243016-d13b3400-c44f-11ea-88ec-c4d14cbfbf97.png)
@@ -89,22 +89,13 @@ or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by
8989
The repo detail view also provides features for performing the following git operations,
9090
```
9191
- Adding a new branch
92-
- List all branches including remote branches
93-
- Switching branches
9492
- Pulling changes from remote
95-
- Branch deletion
9693
- Fetching changes from remote
9794
- Adding a new remote repo
9895
```
99-
![Repo view detail](https://user-images.githubusercontent.com/65342122/87664834-8ee16200-c783-11ea-885e-6a1e29626a47.png)
96+
![repo-card-details](https://user-images.githubusercontent.com/65342122/87232642-1f175400-c3de-11ea-8ead-80cd5ab4c37c.png)
10097

101-
- "List all branches" under available branches, lists all the branches from the local and remote. Click on a branch to checkout to that branch.
102-
- Can delete local branches and if the branches are not in the remote, it cannot be restored.( please be cautious! )
103-
104-
![list-branch](https://user-images.githubusercontent.com/65342122/87667169-812ddb80-c787-11ea-9ff8-98ef2a2f918c.png)
105-
106-
- Show commit logs displays commit history with the timestamp.
107-
![commit-logs](https://user-images.githubusercontent.com/65342122/87232671-71587500-c3de-11ea-8ff5-25fb95b08553.png)
98+
![commit-logs](https://user-images.githubusercontent.com/65342122/88486754-9a136980-cf9d-11ea-94ad-436834cacf07.png)
10899

109100

110101
#### Add new branch
@@ -124,7 +115,7 @@ Note: In a newly initialized git repo, the newly added branch will be considered
124115
![git-operations](https://user-images.githubusercontent.com/65342122/87232645-30f8f700-c3de-11ea-8ddb-52f4d5ec7140.png)
125116

126117
- The staged files can be removed individually or it can be removed all at once.
127-
![staged-files](https://user-images.githubusercontent.com/65342122/87232658-51c14c80-c3de-11ea-95e1-b9bbeeac82bb.png)
118+
![staged-files](https://user-images.githubusercontent.com/65342122/88487285-4f93ec00-cfa1-11ea-8824-a70b3ba75d45.png)
128119

129120
- The staged changes can be committed using the **Commit changes** option. This will display a pop-up with all the staged files and it requires a commit message to successfully commit the changes. The commit messages can either be a single line message or a multi-line message
130121
![commit-changes](https://user-images.githubusercontent.com/65342122/87232659-56860080-c3de-11ea-9bc4-a19ad727b101.png)
@@ -133,7 +124,7 @@ Note: In a newly initialized git repo, the newly added branch will be considered
133124
![push-operation-with-remote](https://user-images.githubusercontent.com/65342122/87232662-61409580-c3de-11ea-8ad7-61c3871f0a4d.png)
134125

135126
This section will let you know if the selected remote is not valid or if the push operation fails
136-
![push-opeartion-without-remote](https://user-images.githubusercontent.com/65342122/87232666-6867a380-c3de-11ea-9903-5ea12200e994.png)
127+
![push-opeartion-without-remote](https://user-images.githubusercontent.com/65342122/88487148-3ccce780-cfa0-11ea-874f-a2844760483f.png)
137128

138129
### Git Difference
139130

0 commit comments

Comments
 (0)