Skip to content

Commit f5796bf

Browse files
committed
Update changelog and README for v1.0.1 release; add extension logo, screenshot, and "Getting Started" section
1 parent 8089570 commit f5796bf

File tree

5 files changed

+21
-37
lines changed

5 files changed

+21
-37
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,22 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
66

77
## [Unreleased]
88

9+
10+
## v1.0.1
11+
### Added
12+
- Extension Logo
13+
- Screenshot in the README file.
14+
- Added a "Getting Started" section to the README.
15+
16+
## v1.0.0
917
### Added
1018
- View log files in the `var/log` directory of your Magento project.
1119
- Open log files directly in the editor by clicking on them in the tree view.
1220
- Expand log files to view individual lines.
1321
- Clear all log files with a single command.
1422
- Status bar item showing the number of log entries.
1523
- Badge in the tree view showing the total number of log entries.
24+
- Repository field in `package.json`.
1625

1726
### Changed
1827
- Status bar item now shows the total number of log entries instead of the number of log files.

README.md

Lines changed: 10 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The Magento Log Viewer extension for Visual Studio Code allows you to easily view and manage log files in your Magento project. This extension provides a tree view of log files, the ability to open and clear log files, and a status bar item showing the number of log entries.
44

5+
![Magento Log Viewer Screenshot](resources/screenshot.png)
6+
57
## Features
68

79
- **View Log Files**: Displays a tree view of log files in the `var/log` directory of your Magento project.
@@ -15,12 +17,15 @@ The Magento Log Viewer extension for Visual Studio Code allows you to easily vie
1517
- Visual Studio Code version 1.95.0 or higher.
1618
- A Magento project with log files located in the `var/log` directory.
1719

18-
## Extension Settings
19-
20-
This extension contributes the following settings:
20+
## Getting Started
2121

22-
- `magentoLogViewer.isMagentoProject`: Indicates whether the current workspace is a Magento project. Options are "Yes", "No", and "Please select".
23-
- `magentoLogViewer.magentoRoot`: The path to the Magento root folder.
22+
1. **Install the extension**: Install the Magento Log Viewer extension from the Visual Studio Code marketplace.
23+
2. **Open your Magento project**: Open your Magento project in Visual Studio Code.
24+
3. **Configure the extension**: When you open a workspace, the extension will prompt you to specify if it is a Magento project. If you select "Yes", you will be prompted to select the Magento root folder.
25+
4. **View log files**: The log files will be displayed in the tree view under the "Magento Log Viewer" activity bar.
26+
5. **Open log files**: Click on any log file in the tree view to open it in the editor.
27+
6. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines.
28+
7. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory.
2429

2530
## Usage
2631

@@ -31,35 +36,4 @@ This extension contributes the following settings:
3136
5. **Expand log files**: Click on the arrow next to a log file to expand and view individual lines.
3237
6. **Clear log files**: Use the "Clear all Logs" command to delete all log files in the `var/log` directory.
3338

34-
## Known Issues
35-
36-
- None at the moment. Please report any issues you encounter.
37-
38-
## Release Notes
39-
40-
### 0.0.1
41-
42-
- Initial release of Magento Log Viewer.
43-
44-
---
45-
46-
## Following extension guidelines
47-
48-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
49-
50-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
51-
52-
## Working with Markdown
53-
54-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
57-
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
58-
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
59-
60-
## For more information
61-
62-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
64-
6539
**Enjoy!**

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
"name": "magento-log-viewer",
33
"displayName": "Magento Log Viewer",
44
"description": "A Visual Studio Code extension to view and manage Magento log files.",
5-
"version": "1.0.0",
5+
"version": "1.0.1",
66
"publisher": "MathiasElle",
7+
"icon": "resources/logo.png"
78
"repository": {
89
"type": "git",
910
"url": "https://github.com/dermatz/vscode-ext-magento-log-viewer"

resources/logo.png

306 KB
Loading

resources/screenshot.png

60.1 KB
Loading

0 commit comments

Comments
 (0)