mirror of
https://github.com/ckaczor/vscode-gitlens.git
synced 2026-01-14 01:25:43 -05:00
Updates README with more details
This commit is contained in:
30
README.md
30
README.md
@@ -1,22 +1,32 @@
|
||||
# GitLens
|
||||
|
||||
Provides Git information (most recent commit, # of authors) in CodeLens, on-demand inline blame annotations, a blame explorer, and commands to compare changes with the working tree or previous versions.
|
||||
Provides Git information (most recent commit, # of authors) in CodeLens, on-demand inline blame annotations, status bar blame information, a blame explorer, and commands to compare changes with the working tree or previous versions.
|
||||
|
||||
---
|
||||
## Features
|
||||
|
||||
Provides two CodeLens on code blocks:
|
||||
- **Recent Change** - author and date of the most recent check-in
|
||||
> Clicking on the CodeLens opens a **Blame explorer** with the commits and changed lines in the right pane and the commit (file) contents on the left
|
||||
- **Authors** - number of authors of a block and the most prominent author (if there are more than one)
|
||||
> Clicking on the CodeLens toggles Git blame annotations on/off
|
||||
- Provides **CodeLens** on code blocks:
|
||||
- **Recent Change** - author and date of the most recent check-in for that block
|
||||
> Clicking on the CodeLens opens a **Blame history explorer** with the commits and changed lines in the right pane and the commit (file) contents on the left
|
||||
- **Authors** - number of authors of a block and the most prominent author (if there are more than one)
|
||||
> Clicking on the CodeLens toggles Git blame annotations on/off
|
||||
- Provides on-demand **inline blame annotations** with multiple styles
|
||||
- Provides Git blame information about the selected line in the **status bar**
|
||||
- Provides a Git **blame history explorer** to visualize the history of a file or block
|
||||
- Provides ability to **compare diffs** with the working tree as well as with previous versions
|
||||
- Provides many configuration settings to allow the **customization** of almost all Features
|
||||
|
||||
---
|
||||
## Screenshots
|
||||
|
||||
## Screenshot
|
||||
> 
|
||||
|
||||
---
|
||||
## Requirements
|
||||
|
||||
Must be using Git and it must be in your path.
|
||||
|
||||
---
|
||||
## Extension Settings
|
||||
|
||||
|Name | Description
|
||||
@@ -35,16 +45,18 @@ Must be using Git and it must be in your path.
|
||||
|`gitlens.statusBar.enabled`|Specifies whether blame information is shown in the status bar
|
||||
|`gitlens.statusBar.command`|"Specifies the command executed when the blame status bar item is clicked. `gitlens.toggleBlame` - toggles blame annotations. `gitlens.showBlameHistory` - opens the blame history explorer. `gitlens.diffWithPrevious` - compares the current checked-in file with the previous commit. `git.viewFileHistory` - opens a file history picker, which requires the Git History (git log) extension"
|
||||
|
||||
---
|
||||
## Known Issues
|
||||
|
||||
- Content in the **Blame explorer** disappears after a bit: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
|
||||
- Content in the **Blame history explorer** disappears after a bit: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
|
||||
- Highlighted lines disappear in **Blame explorer** after changing selection and returning to a previous selection: [vscode issue](https://github.com/Microsoft/vscode/issues/11360)
|
||||
- CodeLens aren't updated properly after a file is saved: [vscode issue](https://github.com/Microsoft/vscode/issues/11546)
|
||||
- Visible whitespace causes issue with blame overlay (currently fixed with a hack, but fails randomly): [vscode issue](https://github.com/Microsoft/vscode/issues/11485)
|
||||
|
||||
---
|
||||
## Release Notes
|
||||
|
||||
### 0.5.0
|
||||
### 0.5.1
|
||||
|
||||
- Adds blame information in the statusBar
|
||||
- Add new StatusBar settings -- see **Extension Settings** above for details
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "gitlens",
|
||||
"version": "0.5.0",
|
||||
"version": "0.5.1",
|
||||
"author": {
|
||||
"name": "Eric Amodio",
|
||||
"email": "eamodio@gmail.com"
|
||||
|
||||
Reference in New Issue
Block a user