Skip to content

Commit 65f8178

Browse files
axosoft-ramintd13
authored andcommitted
Updates README
- Adds new features - Updates images - Updates Pro and Preview badging
1 parent 56145f5 commit 65f8178

File tree

5 files changed

+45
-28
lines changed

5 files changed

+45
-28
lines changed

README.md

Lines changed: 45 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Use `Switch to Pre-Release Version` on the extension banner to live on the edge
2222

2323
All features are free to use on all repos, **except** for features,
2424

25-
- marked with a require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately-hosted repos
26-
- marked with a ☁️ require a GitKraken account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
25+
- marked with a `Pro` require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately-hosted repos
26+
- marked with a `Preview` require a GitKraken account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
2727

2828
See the [FAQ](#is-gitlens-free-to-use 'Jump to FAQ') for more details.
2929

@@ -44,10 +44,13 @@ Quickly glimpse into when, why, and by whom a line or code block was changed. Ze
4444
- [**File Annotations**](#file-annotations) — Toggle on-demand whole file annotations to see authorship, recent changes, and a heatmap.
4545
- [**Revision Navigation**](#revision-navigation) — Explore the history of a file to see how the code evolved over time.
4646
- [**Side Bar Views**](#side-bar-views) — Powerful views into Git that don't come in the box.
47-
- [**Commit Graph ✨**](#commit-graph-✨) — Visualize your repository and keep track of all work in progress.
48-
- [**GitKraken Workspaces ☁️ and Launchpad ✨**](#gitkraken-workspaces-☁️-and-focus-✨) — Easily group and manage multiple repositories and bring pull requests and issues into a unified view.
49-
- [**Visual File History ✨**](#visual-file-history-✨) — Identify the most impactful changes to a file and by whom.
50-
- [**Worktrees ✨**](#worktrees-✨) — Simultaneously work on different branches of a repository.
47+
- [**Commit Graph `Pro`**](#commit-graph-pro) — Visualize your repository and keep track of all work in progress.
48+
- [**Cloud Patches `Preview`**](#cloud-patches-preview) — Easily and securely share code with your teammates.
49+
- [**GitKraken Workspaces `Preview`**](#gitkraken-workspaces-preview) — Easily group and manage multiple repositories.
50+
- [**Code Suggest `Pro`**](#code-suggest-pro) — Free your code reviews from unnecessary restrictions.
51+
- [**Launchpad `Pro`**](#launchpad-pro) — Stay focused and keep your team unblocked.
52+
- [**Visual File History `Pro`**](#visual-file-history-pro) — Identify the most impactful changes to a file and by whom.
53+
- [**Worktrees `Pro`**](#worktrees-pro) — Simultaneously work on different branches of a repository.
5154
- [**Interactive Rebase Editor**](#interactive-rebase-editor) — Visualize and configure interactive rebase operations with a user-friendly editor.
5255
- [**Comprehensive Commands**](#comprehensive-commands) — A rich set of commands to help you do everything you need.
5356
- [**Integrations**](#integrations) — Simplify your workflow and quickly gain insights via integration with your Git hosting services.
@@ -131,15 +134,15 @@ An x-ray or developer tools Inspect into your code, focused on providing context
131134
- **Inspect** — See rich details of a commit or stash.
132135
- **Line History** — Jump through the revision history of the selected line(s).
133136
- **File History** — Explore the revision history of a file, folder, or selected lines.
134-
- [**Visual File History **](#visual-file-history-) — Quickly see the evolution of a file, including when changes were made, how large they were, and who made them.
137+
- [**Visual File History `Pro`**](#visual-file-history-pro) — Quickly see the evolution of a file, including when changes were made, how large they were, and who made them.
135138
- **Search & Compare** — Search and explore for a specific commit, message, author, changed file or files, or even a specific code change, or visualize comparisons between branches, tags, commits, and more.
136139

137140
### GitLens
138141

139142
Quick access to many GitLens features. Also the home of GitKraken teams and collaboration services (e.g. GitKraken Workspaces), help, and support.
140143

141144
- **Home** — Quick access to many features.
142-
- [**GitKraken Workspaces ☁️**](#gitkraken-workspaces-☁️-and-focus-✨) — Easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow.
145+
- [**GitKraken Workspaces `Preview`**](#gitkraken-workspaces-preview) — Easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow.
143146
- **GitKraken Account** — Power-up with GitKraken Cloud Services.
144147

145148
### Source Control
@@ -151,56 +154,70 @@ Shows additional views that are focused on exploring and managing your repositor
151154
- **Remotes** — Manage and navigate remotes and remote branches.
152155
- **Stashes** — Save and restore changes you are not yet ready to commit.
153156
- **Tags** — Manage and navigate tags.
154-
- [**Worktrees **](#worktrees-) — Simultaneously work on different branches of a repository.
157+
- [**Worktrees `Pro`**](#worktrees-pro) — Simultaneously work on different branches of a repository.
155158
- **Contributors** — Ordered list of contributors, providing insights into individual contributions and involvement.
156159
- **Repositories** — Unifies the above views for more efficient management of multiple repositories.
157160

158161
### (Bottom) Panel
159162

160163
Convenient and easy access to the Commit Graph with a dedicated details view.
161164

162-
- [**Commit Graph **](#commit-graph-) — Visualize your repository and keep track of all work in progress.
165+
- [**Commit Graph `Pro`**](#commit-graph-pro) — Visualize your repository and keep track of all work in progress.
163166

164-
## Commit Graph
167+
## Commit Graph `Pro`
165168

166169
Easily visualize your repository and keep track of all work in progress.
167170

168171
Use the rich commit search to find exactly what you're looking for. Its powerful filters allow you to search by a specific commit, message, author, a changed file or files, or even a specific code change.
169172

170173
<figure align="center">
171-
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-graph-illustrated.png" alt="Commit Graph" />
174+
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-graph.png" alt="Commit Graph" />
172175
</figure>
173176

174177
💡Quickly toggle the Graph via the `Toggle Commit Graph` command.
175178

176179
💡Maximize the Graph via the `Toggle Maximized Commit Graph` command.
177180

178-
## GitKraken Workspaces ☁️ and Launchpad ✨
181+
## Cloud Patches `Preview`
182+
183+
Easily and securely share code changes with your teammates or other developers by creating a Cloud Patch from your WIP, commit or stash and sharing the generated link. Use Cloud Patches to collaborate early for feedback on direction, approach, and more, to minimize rework and streamline your workflow.
184+
185+
## GitKraken Workspaces `Preview`
179186

180187
GitKraken Workspaces allow you to easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow. Create workspaces just for yourself or share (coming soon in GitLens) them with your team for faster onboarding and better collaboration.
181188

182-
Launchpad brings all of your GitHub pull requests and issues into a unified actionable view to help to you more easily juggle work in progress, pending work, reviews, and more. Quickly see if anything requires your attention while keeping you focused.
189+
## Code Suggest `Pro`
190+
191+
Liberate your code reviews from GitHub's restrictive, comment-only feedback style. Like suggesting changes on a Google-doc, suggest code changes from where you're already coding — your IDE and on anything in your project, not just on the lines of code changed in the PR.
192+
193+
<figure align="center">
194+
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/code-suggest.png" alt="Code Suggest" />
195+
</figure>
196+
197+
## Launchpad `Pro`
198+
199+
Launchpad brings all of your GitHub pull requests into a unified, actionable list to better track work in progress, pending work, reviews, and more. Stay focused and take action on the most important items to keep your team unblocked.
183200

184201
<figure align="center">
185-
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/focus-view.png" alt="Launchpad" />
202+
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/launchpad.png" alt="Launchpad" />
186203
</figure>
187204

188-
## Visual File History
205+
## Visual File History `Pro`
189206

190207
Quickly see the evolution of a file, including when changes were made, how large they were, and who made them. Use it to quickly find when the most impactful changes were made to a file or who best to talk to about file changes and more.
191208

192209
<figure align="center">
193210
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/visual-file-history-illustrated.png" alt="Visual File History view" />
194211
</figure>
195212

196-
## Worktrees
213+
## Worktrees `Pro`
197214

198215
Efficiently multitask by minimizing the context switching between branches, allowing you to easily work on different branches of a repository simultaneously.
199216

200217
Avoid interrupting your work in progress when needing to review a pull request. Simply create a new worktree and open it in a new VS Code window, all without impacting your other work.
201218

202219
<figure align="center">
203-
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/worktrees-illustrated.png" alt="Worktrees view" />
220+
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/worktrees.png" alt="Worktrees view" />
204221
</figure>
205222

206223
## Interactive Rebase Editor
@@ -237,9 +254,9 @@ Use a series of new commands to:
237254

238255
Context switching kills productivity. GitLens not only reveals buried knowledge within your repository, it also brings additional context from issues and pull requests providing you with a wealth of information and insights at your fingertips.
239256

240-
Simplify your workflow and quickly gain insights with automatic linking of issues and pull requests across multiple Git hosting services including GitHub, GitHub Enterprise , GitLab, GitLab self-managed , Gitea, Gerrit, Google Source, Bitbucket, Bitbucket Server, Azure DevOps, and custom servers.
257+
Simplify your workflow and quickly gain insights with automatic linking of issues and pull requests across multiple Git hosting services including GitHub, GitHub Enterprise `Pro`, GitLab, GitLab self-managed `Pro`, Jira, Gitea, Gerrit, Google Source, Bitbucket, Bitbucket Server, Azure DevOps, and custom servers.
241258

242-
All integration provide automatic linking, while rich integrations with GitHub & GitLab offer detailed hover information for autolinks, and correlations between pull requests, branches, and commits, as well as user avatars for added context.
259+
All integrations provide automatic linking, while rich integrations with GitHub, GitLab and Jira offer detailed hover information for autolinks, and correlations between pull requests, branches, and commits, as well as user avatars for added context.
243260

244261
## Define your own autolinks
245262

@@ -259,26 +276,26 @@ Use the `Generate Commit Message` command from the Source Control view's context
259276

260277
# Ready for GitLens Pro?
261278

262-
When you're ready to unlock the full potential of GitLens and enjoy all the benefits on your privately-hosted repos, consider upgrading to GitLens Pro. With GitLens Pro, you'll gain access to features on privately-hosted repos and ☁️ features based on the Pro plan.
279+
When you're ready to unlock the full potential of GitLens and enjoy all the benefits on your privately-hosted repos, consider upgrading to GitLens Pro. With GitLens Pro, you'll gain access to `Pro` features on privately-hosted repos.
263280

264-
To learn more about the pricing and the additional ✨ and ☁️ features offered with GitLens Pro, visit the [GitLens Pricing page](https://www.gitkraken.com/gitlens/pricing). Upgrade to GitLens Pro today and take your Git workflow to the next level!
281+
To learn more about the pricing and the additional features offered with GitLens Pro, visit the [GitLens Pricing page](https://www.gitkraken.com/gitlens/pricing). Upgrade to GitLens Pro today and take your Git workflow to the next level!
265282

266283
# FAQ
267284

268285
## Is GitLens free to use?
269286

270287
Yes. All features are free to use on all repos, **except** for features,
271288

272-
- marked with a require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately-hosted repos
273-
- marked with a ☁️ require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
289+
- marked with a `Pro` require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately-hosted repos
290+
- marked with a `Preview` require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
274291

275-
While GitLens offers a remarkable set of free features, a subset of features tailored for professional developers and teams, marked with a , require a trial or paid plan for use on privately-hosted repos &mdash; use on local or publicly-hosted repos is free for everyone. Additionally some features marked with a ☁️, rely on GitKraken Dev Services which requires a GitKraken account and access is based on your plan, e.g. Free, Pro, etc.
292+
While GitLens offers a remarkable set of free features, a subset of features tailored for professional developers and teams, marked with a `Pro`, require a trial or paid plan for use on privately-hosted repos &mdash; use on local or publicly-hosted repos is free for everyone. Additionally some features marked with a `Preview`, rely on GitKraken Dev Services which requires a GitKraken account and access is based on your plan, e.g. Free, Pro, etc.
276293

277-
Preview features instantly for free for 3 days without an account, or start a free GitLens Pro trial to get an additional 7 days and gain access to ☁️ features to experience the full power of GitLens.
294+
Preview `Pro` features instantly for free for 3 days without an account, or start a free GitLens Pro trial to get an additional 7 days and gain access to `Pro` features to experience the full power of GitLens.
278295

279-
## Are and ☁️ features free to use?
296+
## Are `Pro` and `Preview` features free to use?
280297

281-
features are free for use on local and publicly-hosted repos, while a paid plan is required for use on privately-hosted repos. ☁️ feature access is based on your plan including a Free plan.
298+
`Pro` features are free for use on local and publicly-hosted repos, while a paid plan is required for use on privately-hosted repos. `Preview` feature access is based on your plan including a Free plan.
282299

283300
## Where can I find pricing?
284301

images/docs/code-suggest.png

597 KB
Loading

images/docs/commit-graph.png

223 KB
Loading

images/docs/launchpad.png

533 KB
Loading

images/docs/worktrees.png

620 KB
Loading

0 commit comments

Comments
 (0)