Skip to content

Commit a42e51f

Browse files
committed
Update some files for release
1 parent 299c847 commit a42e51f

File tree

4 files changed

+32
-54
lines changed

4 files changed

+32
-54
lines changed

.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
*.gif filter=lfs diff=lfs merge=lfs -text
12
*.png filter=lfs diff=lfs merge=lfs -text

CHANGELOG.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,17 @@
22

33
All notable changes to the "searchrep" extension will be documented in this file.
44

5-
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
88

9+
- Add tests
10+
11+
## [1.0.0] - 2020-11-20
12+
13+
### Added
14+
915
- Initial release
16+
17+
[Unreleased]: https://github.com/satosystems/searchrep/compare/v1.0.0...HEAD
18+
[1.0.0]: https://github.com/satosystems/searchrep/releases/tag/v1.0.0

README.md

+18-53
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,30 @@
1-
# searchrep README
1+
# searchrep - Visual Studio Code Extension
22

3-
This is the README for your extension "searchrep". After writing up a brief description, we recommend including the following sections.
3+
This extension replaces any files in the search results with any contents in bulk.
44

55
## Features
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
![screencast](https://media.githubusercontent.com/media/satosystems/searchrep/main/images/demo.gif)
88

9-
For example if there is an image subfolder under your extension project workspace:
9+
- YouTube: <https://youtu.be/bZKkUyePc68>
1010

11-
\!\[feature X\]\(images/feature-x.png\)
11+
### How to use
1212

13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
14-
15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: enable/disable this extension
28-
* `myExtension.thing`: set to `blah` to do something
13+
1. Search
14+
2. Click `Open in editor` link at Search Bar
15+
3. Edit search results freely
16+
- You can edit lines other than the search results
17+
- You can replace lines that are not in the search results by adding line numbers.
18+
4. Execute SearchRep by one of the following:
19+
- Command of command palette: `SearchRep` (case insensitive)
20+
- Keyboard shortcut:
21+
- Windows or Linux: `Ctrl+Shift+R`
22+
- macOS: `command+shift+R`
2923

3024
## Known Issues
3125

32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
-----------------------------------------------------------------------------------------------------------
51-
52-
## Working with Markdown
53-
54-
**Note:** 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) or `Cmd+Space` (macOS) to see a list of Markdown snippets
59-
60-
### For more information
26+
This extension replaces files assuming file encoding is UTF-8.
6127

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/)
28+
### Acknowledgement
6429

65-
**Enjoy!**
30+
- Icon: [SnipIcons Regular, 100 free Icons by Snip Master](https://icon-icons.com/en/pack/SnipIcons-Regular/1523)

images/demo.gif

+3
Loading

0 commit comments

Comments
 (0)