Skip to content

Commit 32ca0b6

Browse files
committed
updated the readme
1 parent bd1644a commit 32ca0b6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ Allows adding updates to the projects owned by the users
99
## Requirements
1010

1111
- Valid Commit account, as this is needed to get Authenticated
12-
- Already existing projects.
1312

14-
## Installing
13+
## Downloading & Installing
1514

16-
As this extension is private, you need to install it from the VSIX file using the command line as follows:
15+
As this extension is private, you need to manually download the file from latest Release of the project from GitHub account from project's [Latest Release](https://github.com/commitdev/vscode-extension/releases/latest). Click on `.vsix` file to download it. Once you have the file, you can install the extension by following the steps below:
1716

1817
```bash
19-
code --install-extension commit-extension-<VERSION NUMBER>.vsix
18+
code --install-extension <FILE_DOWNLOAD_PATH>/commit-extension-<VERSION_NUMBER>.vsix
2019
```
2120

2221
## Getting Started
@@ -39,20 +38,21 @@ Follow the steps below to add an update to your project:
3938
- You will see a message `Update added successfully` in the bottom right corner.
4039

4140
## Known Issues
41+
4242
Following are the known issues with the extension:
4343

4444
- Currently the project structure is not optimized as current version is a POC.
4545
- There is no testing reports for the extension, thus no CI/CD jobs for that as well.
4646

4747
## Feature Roadmap
48+
4849
Following are the features that are planned to be added in the future:
4950

5051
- Add ability to link single Git Project to given workspace.
5152
- Add ability to make other updates such as adding a new project, adding a comment, etc.
5253
- Update Project View to replicate information from Commit Project page.
5354
- Add ability to connect Github repository to the project, in order to pull information from Github repo such as code type, language, code precentage etc.
5455

55-
5656
## Resources
5757

5858
- [Git API](https://github.com/microsoft/vscode/tree/main/extensions/git)

0 commit comments

Comments
 (0)