Skip to content

Commit 26b6101

Browse files
update readme
1 parent 45c6197 commit 26b6101

2 files changed

Lines changed: 18 additions & 49 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to the "vscode-cashscript" extension will be documented in t
44

55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

7-
## [Unreleased]
8-
9-
- Initial release
7+
## 1.0.0
8+
Initial release of vscode-cashscript. Features:
9+
- Syntax Highlighting
10+
- Auto-Completion
11+
- Snippets
12+
- Linting
13+
- Contract Compilation (press F5 or click "Compile Contract")

README.md

Lines changed: 11 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# vscode-cashscript
22

3-
Vscode-cashscript provides tools that make it easier for developers to write smart contracts with [cashscript](cashscript.org).
3+
Vscode-cashscript provides tools that make it easier for developers to write smart contracts with [cashscript](https://cashscript.org/).
44

55
![example of vscode-cashscript](media/p2pkh.gif)
66

@@ -12,62 +12,27 @@ Vscode-cashscript provides tools that make it easier for developers to write sma
1212
- Linting
1313
- Contract Compilation
1414

15-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
15+
## Instructions
1616

17-
For example if there is an image subfolder under your extension project workspace:
18-
19-
\!\[feature X\]\(images/feature-x.png\)
20-
21-
> 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.
22-
23-
## Requirements
24-
25-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
17+
Press **F5** or click the "**Compile Contract**" button in the top right. A json file containing the contract artifiact will be created in the same directory with the same name.
2618

2719
## Extension Settings
2820

29-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
30-
31-
For example:
32-
33-
This extension contributes the following settings:
34-
35-
* `myExtension.enable`: enable/disable this extension
36-
* `myExtension.thing`: set to `blah` to do something
21+
None available yet.
3722

3823
## Known Issues
3924

4025
Calling out known issues can help limit users opening duplicate issues against your extension.
4126

4227
## Release Notes
4328

44-
Users appreciate release notes as you update your extension.
29+
Check the [changelog](/CHANGELOG.md) for past releases. Latest stable version:
4530

4631
### 1.0.0
4732

48-
Initial release of ...
49-
50-
### 1.0.1
51-
52-
Fixed issue #.
53-
54-
### 1.1.0
55-
56-
Added features X, Y, and Z.
57-
58-
-----------------------------------------------------------------------------------------------------------
59-
60-
## Working with Markdown
61-
62-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
63-
64-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
65-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
66-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
67-
68-
### For more information
69-
70-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
71-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
72-
73-
**Enjoy!**
33+
Initial release of vscode-cashscript. Features:
34+
- Syntax Highlighting
35+
- Auto-Completion
36+
- Snippets
37+
- Linting
38+
- Contract Compilation (press F5 or click "Compile Contract")

0 commit comments

Comments
 (0)