Skip to content

Commit 084dd18

Browse files
committed
docs: Update README
1 parent c8fe69c commit 084dd18

2 files changed

Lines changed: 34 additions & 11 deletions

File tree

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88

9+
## [0.1.6] - 2026-01-03
10+
11+
### Documentation
12+
13+
#### Updated README
14+
- Added interactive Marketplace badges of installs and rating, and added links to all badges.
15+
- Updated top links for better readability.
16+
- Added a link to "Current limitations" in the "Disclaimer" section.
17+
- Refined the "Current limitations" list for better clarity and readability.
18+
19+
920
## [0.1.5] - 2025-12-31
1021

1122
### New Year Release 🎄❄️✨

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,27 @@
22
<div align="center">
33
<img src="./assets/logo.png" alt="logo" width="150" />
44
<h1>GraphLens</h1>
5-
<p>
6-
<img src="https://img.shields.io/badge/version-0.1.5-blue.svg" alt="version" />
7-
<img src="https://img.shields.io/badge/status-Public%20Beta-orange.svg" alt="status" />
8-
<img src="https://img.shields.io/badge/license-Proprietary-red.svg" alt="license" />
5+
<p align="center">
6+
<a href="https://marketplace.visualstudio.com/items?itemName=GraphLens.graphlens&ssr=false#overview">
7+
<img src="https://img.shields.io/badge/version-0.1.6-blue.svg" alt="version" />
8+
</a>
9+
<a href="https://github.com/GraphLens/graphlens">
10+
<img src="https://img.shields.io/badge/status-Public%20Beta-orange.svg" alt="status" />
11+
</a>
12+
<a href="https://github.com/GraphLens/graphlens?tab=License-1-ov-file">
13+
<img src="https://img.shields.io/badge/license-Proprietary-red.svg" alt="license" />
14+
</a>
15+
<a href="https://marketplace.visualstudio.com/items?itemName=GraphLens.graphlens&ssr=false#overview">
16+
<img src="https://img.shields.io/visual-studio-marketplace/i/GraphLens.graphlens?color=blue&label=installs" alt="installs">
17+
</a>
18+
<a href="https://marketplace.visualstudio.com/items?itemName=GraphLens.graphlens&ssr=false#review-details">
19+
<img src="https://img.shields.io/visual-studio-marketplace/r/GraphLens.graphlens?style=flat&label=rating" alt="rating">
20+
</a>
921
</p>
1022
<h3>Interactive architecture visualizer for Angular projects</h3>
1123
<p>Transforms tangled code into structured, navigable graphs</p>
1224
<a href="https://marketplace.visualstudio.com/items?itemName=graphlens.graphlens" target="_blank">Marketplace</a> •
13-
<a href="https://github.com/GraphLens/graphlens">GitHub Repo</a> •
14-
<a href="https://github.com/GraphLens/demo">Demo</a> •
25+
<a href="https://github.com/GraphLens/demo">GitHub Demo</a> •
1526
<a href="https://github.com/GraphLens/graphlens/issues">Issues</a>
1627
</div>
1728

@@ -29,7 +40,7 @@
2940

3041
### ⚠️ Disclaimer
3142

32-
GraphLens is currently in **Public Beta**. While we strive for maximum stability, graph rendering discrepancies may occur in projects with non-standard Angular configurations and complex code patterns.
43+
GraphLens is currently in **Public Beta**. While we strive for maximum stability, graph rendering discrepancies may occur in projects with non-standard Angular configurations and complex code patterns. Please review the [Current limitations](#4-current-limitations) section before use.
3344

3445
GraphLens supports **Angular v2+** projects only. Angular libraries and SSR are not supported at this time. React and Vue frameworks are not supported yet. Graphs currently require manual refresh.
3546

@@ -131,12 +142,13 @@ GraphLens leverages VS Code's built-in capabilities to find definitions and refe
131142

132143
## 4. Current Limitations
133144

134-
- **Frameworks:** Supports **Angular v2+** only. React and Vue are not supported at this moment.
135-
- **Monorepos:** Nx workspace tools and specific structures are not supported.
145+
- **Program Entities Types:** Supports only Angular Modules, Components, Directives, and Routes. Content projection, DI services and other Angular building entities are not supported yet, but are planned for future releases.
136146
- **Project Types:** Angular libraries are not supported yet.
147+
- **Monorepos:** Nx workspace tools and specific configurations are not supported.
148+
- **Manual Refresh:** The graphs do not update automatically upon file save. See the [Manual Refresh](#25-manual-refresh) section for details.
137149
- **SSR Support:** Server-side logic is not supported.
138-
- **Manual Refresh:** The graphs do not update automatically upon file save. See section 2.5 for details.
139-
- **IDE Support:** Available for **Visual Studio Code** only. JetBrains IDEs (WebStorm, IntelliJ IDEA) is planned for future releases.
150+
- **Frameworks:** Supports **Angular v2+** only. React and Vue are not supported at this moment.
151+
- **IDE Support:** Available for **Visual Studio Code** only. Extension version for JetBrains IDEs (WebStorm, IntelliJ IDEA) is planned for future releases.
140152

141153

142154
## 5. Roadmap

0 commit comments

Comments
 (0)