Skip to content

Commit adc4a92

Browse files
committed
updated readme and package json for v1.1.6 release
1 parent 1b7815d commit adc4a92

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
> Use any of the below options to get gitconvex for your system
2020
21-
[![gitconvex npm package](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@itassistors/gitconvex)
22-
[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
23-
[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
21+
[![gitconvex npm package](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.6&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@itassistors/gitconvex)
22+
[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.6&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
23+
[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.6&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
2424
[![License](https://img.shields.io/static/v1?label=LICENSE&message=Apache-2.0&color=yellow&style=for-the-badge)](LICENSE)
2525

2626
- **Option - 1** Cloning repo from **github**
@@ -88,6 +88,30 @@ $ npm start
8888
| <b>[Node js](https://nodejs.org/en/)</b> | <b>Tested on v12.0+ |
8989
|--|--|
9090
| <b>[Git](https://git-scm.com/)</b> | <b>Tested on v2.20+</b> |
91+
92+
> **Important note for windows users**
93+
94+
If you are a windows user, then make sure that `git` is accessible from the command line without using git bash.
95+
96+
- Open command prompt or powershell and enter `git --version` and press enter. If it displays the following output, then it is fine
97+
98+
```
99+
C:\> git --version
100+
101+
git version 2.28.0.windows.1
102+
```
103+
104+
If this output is not displayed and if the command throws the following error, then it shows that `git` is not added to the 'path' environment variable and it will not be accessible directly from the command line,
105+
106+
```
107+
C:\> git --version
108+
109+
'git' is not recognized as an internal or external command,
110+
operable program or batch file.
111+
```
112+
113+
This can be fixed by adding `git` to the PATH environment variable in windows. The process of setting this up is available [here](https://stackoverflow.com/questions/26620312/git-installing-git-in-path-with-github-client-for-windows#answer-53706956:~:text=comment-,27,Here%20is%20the%20magic)
114+
91115

92116
# Detailed documentation
93117

@@ -97,3 +121,5 @@ Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use th
97121

98122
See [LICENSE ](LICENSE) info for more
99123

124+
125+

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "gitconvex",
2+
"name": "@itassistors/gitconvex",
33
"version": "1.1.6",
44
"description": "Git web UI client to manage your git repositories",
55
"main": "server.js",

0 commit comments

Comments
 (0)