Skip to content

Commit 66505ea

Browse files
authored
update README with new details
1 parent 4c86dde commit 66505ea

File tree

1 file changed

+12
-25
lines changed

1 file changed

+12
-25
lines changed

README.md

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Gitconvex
22

3-
### Web application for managing all your git repositories
3+
### Web application for managing your git repositories
44

55
<p align="center">
66
<img src="https://user-images.githubusercontent.com/47709856/87170859-8bfff080-c2ef-11ea-9140-b9e5db1c17d8.png" width="280">
@@ -22,9 +22,9 @@
2222
[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v2.0.1&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
2323

2424

25-
- **Option - 1** Cloning repo from **github**
25+
- **Option - 1** Cloning the repo from **github**
2626

27-
**To be Noted :** The `master` branch contains the latest stable build of the project. For a reliable experience, always clone the repo from the master branch.
27+
**To be Noted:** The `master` branch contains the latest and the stable build of the project. For a reliable experience, always clone the repo from the master branch.
2828

2929
``` shell
3030

@@ -46,13 +46,13 @@ make build
4646

4747
```
4848

49-
- **Option - 2** If you are into **docker**, then there is also a docker image available for gitconvex
49+
- **Option - 2** If you are into **docker**, then there is a docker image available for gitconvex
5050

5151
``` shell
5252
docker pull itassistors/gitconvex
5353
```
5454

55-
**Note:** Make sure you mount the host volume to the container to access the git repos from the host system. If you have git repos stored within your containers, then this is not required
55+
**Note:** Make sure you mount the host volume to the container, to access the git repos from the host system. If you have git repos stored within your containers, then this is not required
5656

5757
- **Option - 3** Downloading the zip file from the tagged github [**release**](https://github.com/neel1996/gitconvex/releases)
5858

@@ -80,9 +80,9 @@ make build
8080

8181
| Software | Purpose |
8282
| --- | --- |
83-
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some intense git operations with the target repo</b> |
83+
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some git operations with the target repo</b> |
8484
| <b>[Go](https://golang.org/)</b> | <b>For building the backend from the source</b> |
85-
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the react UI bundle from scratch</b> |
85+
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the React UI bundle from scratch</b> |
8686

8787
> **Important note for windows users**
8888
@@ -105,37 +105,24 @@ C:\> git --version
105105
operable program or batch file.
106106
```
107107

108-
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)
108+
This can be fixed by adding `git` to the PATH environment variable in windows. The steps for 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)
109109

110110
> **🍎 Important note for MacOS users**
111111
112-
The pre-built bundle for MacOS is not a verfieid or signed bundle. So gatekeeper could warn you or even prevent you from using gitconvex on your Mac devices. If this is the case then I recommend building the application from scratch using the `Makefile` included in the repo. Follow **[Option - 1](#download-options)** mentioned above to build the application from scratch.
112+
The pre-built bundle for MacOS is not a verified or signed bundle, so gatekeeper could warn you or even prevent you from using gitconvex on your Mac devices. If this is the case, then I recommend building the application from scratch using the `Makefile` included in the repo. Follow **[Option - 1](#download-options)** mentioned above to build the application from scratch.
113113

114-
**Reason** - Enrolling in the apple developer program for making the application a verfied one will cost me 100 USD anually. So I will do it once the project gets enough reach
114+
**Reason** - Enrolling in the apple developer program for making the application a verified one will cost me 100 USD annually, so I will do it once the project gets enough reach
115115

116116
# Detailed documentation
117117

118118
Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use the platform
119119

120120

121121
# Contributions
122-
123-
This is the final production build for **gitconvex** and direct contributions will not be accepted to this repo. If you wish to contribute to this project, then it has to be made to the following repos which are dedicated to the frontend (React) and backend (Go) for the platform
124-
125-
- **Frontend repo - Build with React JS**
126-
127-
[![gitconvex-ui](https://github-readme-stats-git-master.neel1996.vercel.app/api/pin/?username=neel1996&repo=gitconvex-ui)](https://github.com/neel1996/gitconvex-ui)
128-
129-
- **Backend repo - Build with GoLang**
130-
131-
[![gitconvex-server](https://github-readme-stats-git-master.neel1996.vercel.app/api/pin/?username=neel1996&repo=gitconvex-server)](https://github.com/neel1996/gitconvex-server)
132-
133-
134-
> Please make sure that you are following the contribution guidelines for the respective repos.
135-
122+
Contributions are always welcome for the project. Please do refer the [Contribution Guidelines]( CONTRIBUTING.md) for details
136123
# Help and Feedback
137124

138-
For reporting issues or for requesting any feature use the following medium,
125+
For reporting issues or for requesting a new feature, use the following channels
139126

140127
[**Discord Channel** ](https://discord.gg/PSd2Cq9)
141128

0 commit comments

Comments
 (0)