reduce verbosity in README

Author: neel1996

README.md

@@ -12,12 +12,9 @@ This is the back-end go source repo for the [gitconvex](https://github.com/neel1
 
 ## Dependencies
 
-The dependency packages used by this project can be
-found [here](https://github.com/neel1996/gitconvex-server/network/dependencies)
-
-- **📜 Git Library** - The project uses [git2go](https://github.com/libgit2/git2go) library for all the git operations
-  without relying on the native git client
-- **📈 GraphQL** - [gqlgen](https://github.com/99designs/gqlgen) is used for generating boiler plate GraphQL code which
+- **📜 Git Library** - The project uses [git2go](https://github.com/libgit2/git2go) library for performing all the git
+  operations
+- **📈 GraphQL** - [gqlgen](https://github.com/99designs/gqlgen) is used for generating boiler-plate GraphQL code which
   is the backbone of the whole project
 - **📡 HTTP Router** - [mux](https://github.com/gorilla/mux) is used as the HTTP router for graphql playground and sets
   a handler for the API entry point
@@ -28,139 +25,24 @@ The project uses **git2go** - A libgit2 based binding for go to handle all the g
 properly to run the project.
 
 Follow [these](https://libgit2.org/docs/guides/build-and-link/) instructions to build libgit2
-from [soruce](https://github.com/libgit2/libgit2). Follow this only if you have openssl and libssh setup in your
-machine. If this is not the case then follow the detailed instructions mentioned in [LIBGIT_NOTES](LIBGIT_NOTES.md) for a
-step-by-step guide
+from [source](https://github.com/libgit2/libgit2). Follow this only if you have openssl and libssh setup in your
+machine. If this is not the case then follow the detailed instructions mentioned in [LIBGIT_NOTES](LIBGIT_NOTES.md) for
+a step-by-step guide
 
 If you stumble upon any challenges, then use [this](https://github.com/neel1996/gitconvex-server/discussions/7)
 discussion forum for assistance
 
 ### Contribution Guidelines
 
-Fork the repo and raise a new Pull Request to merge your branch with the `main` branch of this repo. Once the
-review is complete, the PR will be approved and merged
+Fork the repo and raise a new Pull Request to merge your changes with the `main` branch of this repo. Once the review is
+complete, the PR will be approved and merged
 
 ## Gitconvex as a Git API
 
-Gitconvex can function as a service without the UI. The whole API is built with graphql and the underlying queries & mutations can be accessed by invoking `http://localhost:9001/gitconvexapi`. GraphQL playground is also enabled to experiment with the GQL queries and mutations and it can be accessed from `http://localhost:9001/gitconvexapi/graph`
-
-![gql-playground](https://user-images.githubusercontent.com/47709856/113421107-248f5100-93e8-11eb-8c22-9f6337f7c25f.png)
-
-## Project directory tree
-
-**📂 api** - All the common api modules which does not modify the git repo in anyway resides in this directory
-
-**📂 git** - The files in this directory will handle all the git related operations behind the scenes using `go-git` and
-the native `git` client
+Gitconvex can function as a service without the UI. The whole API is build with graphql, and the underlying
+queries/mutations can be accessed by invoking `http://localhost:9001/gitconvexapi`.
 
-**📂 graph** - The GQL schema and other files which are used for enabling GQL based communication are included in this
-directory.
-
-**📂 tests** - As the name suggests, all the test scripts are stored here
-
-**📂 utils** - The common utility modules which are required by other functions to execute common tasks are stored in
-this directory
-
-```
-├── api
-│   ├── add_repo.go
-│   ├── code_file_view.go
-│   ├── fetch_repo.go
-│   ├── health_check.go
-│   ├── repo_status.go
-│   ├── settings_api.go
-│   └── update_repo_name.go
-├── etc
-│   ├── cygwin1.dll
-│   ├── git2.dll
-│   ├── pageant.exe
-│   ├── putty.exe
-│   └── puttygen.exe
-├── git
-│   ├── git_branch_add.go
-│   ├── git_branch_checkout.go
-│   ├── git_branch_compare.go
-│   ├── git_branch_delete.go
-│   ├── git_branch_list.go
-│   ├── git_changed_files.go
-│   ├── git_clone.go
-│   ├── git_commit_changes.go
-│   ├── git_commit_compare.go
-│   ├── git_commit_files.go
-│   ├── git_commit_log_search.go
-│   ├── git_commit_logs.go
-│   ├── git_fetch.go
-│   ├── git_fileline_diff.go
-│   ├── git_init.go
-│   ├── git_ls_files.go
-│   ├── git_pull.go
-│   ├── git_push.go
-│   ├── git_remote_add.go
-│   ├── git_remote_allremotedata.go
-│   ├── git_remote_callbacks.go
-│   ├── git_remote_delete.go
-│   ├── git_remote_edit.go
-│   ├── git_repo.go
-│   ├── git_repo_validate.go
-│   ├── git_reset_item.go
-│   ├── git_resetall_items.go
-│   ├── git_stage_item.go
-│   ├── git_stageall_items.go
-│   ├── git_total_commits.go
-│   └── git_unpushed_commits.go
-├── gitconvex-k8s.yml
-├── gitconvex-ui
-├── global
-│   ├── GlobalLogger.go
-│   ├── common_strings.go
-│   ├── current_version.go
-│   ├── errors.go
-│   └── status_strings.go
-├── go.mod
-├── go.sum
-├── gqlgen.yml
-├── graph
-│   ├── generated
-│   │   └── generated.go
-│   ├── model
-│   │   ├── aux_models.go
-│   │   └── models_gen.go
-│   ├── resolver.go
-│   ├── schema.graphqls
-│   └── schema.resolvers.go
-├── make.bat
-├── server.go
-├── tests
-│   ├── beforeAll_git_clone_test.go
-│   ├── code_file_view_test.go
-│   ├── encrypt_https_password_test.go
-│   ├── git_branch_add_test.go
-│   ├── git_branch_delete_test.go
-│   ├── git_branch_test.go
-│   ├── git_changed_files_test.go
-│   ├── git_commit_changes_test.go
-│   ├── git_commit_compare_test.go
-│   ├── git_commit_files_test.go
-│   ├── git_commit_log_search_test.go
-│   ├── git_commit_logs_test.go
-│   ├── git_ls_files_test.go
-│   ├── git_remote_add_test.go
-│   ├── git_remote_allremotedata_test.go
-│   ├── git_remote_data_test.go
-│   ├── git_remote_delete_test.go
-│   ├── git_remote_edit_test.go
-│   ├── git_resetall_items_test.go
-│   ├── git_total_commits_test.go
-│   ├── git_unpushed_commits_test.go
-│   ├── health_check_test.go
-│   └── update_repo_name_test.go
-└── utils
-    ├── db_file_reader.go
-    ├── db_file_writer.go
-    ├── encrypt_https_password.go
-    ├── env_file_handler.go
-    └── git_standalone_client.go
-
-10 directories, 88 files
-```
+GraphQL playground is enabled to experiment with the GQL queries and mutations. It can be accessed
+from `http://localhost:9001/gitconvexapi/graph`
 
+![gql-playground](https://user-images.githubusercontent.com/47709856/113421107-248f5100-93e8-11eb-8c22-9f6337f7c25f.png)

git/remote/git_remote_url_data_test.go

@@ -0,0 +1,2 @@
+package remote
+