Skip to content

Commit

Permalink
update readme, changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
CER10TY committed Sep 16, 2019
1 parent 56824de commit 8ee00b8
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 51 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ out
node_modules
.vscode-test/
*.vsix
34545231.txt
4 changes: 1 addition & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

All notable changes to the "hncode2" extension will be documented in this file.

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

## [Unreleased]
## [0.0.1]

- Initial release
66 changes: 19 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,37 @@
# hncode2 README

This is the README for your extension "hncode2". After writing up a brief description, we recommend including the following sections.
</br>
<div align="center">
<img src="https://raw.githubusercontent.com/cer10ty/hncode/master/public/images/HNCode.png" alt="HNCode Logo" height="250px" width="250px"></img>
</div>
</br>
<div align="center">
<h1>HNCode²</h1>
<h2>Visual Studio Code Extension to browse Hacker News (in a tree view)</h2>
</div>
</br>

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> 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.
* Browse top stories of HN in a tree view
* Browse Ask HN in a tree view
* Go straight to external URLs or self posts from the tree view

## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
This extension requires Visual Studio Code 1.38.0 or later to work properly.

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:

This extension contributes the following settings:

* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something
* `hncode.limitation`: Set the amount of items to be loaded on the front page.

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.
* It looks ugly.
* Not all tabs (like jobs, new) are implemented yet.

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

-----------------------------------------------------------------------------------------------------------

## Working with Markdown

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets

### For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
### 0.0.1

**Enjoy!**
Pre-alpha Release
12 changes: 11 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
{
"name": "hncode2",
"displayName": "hncode2",
"displayName": "HNCode²",
"description": "Browse Hacker News in a tree view tab",
"version": "0.0.1",
"publisher": "sjohanson",
"author": "Søren Johanson <[email protected]>",
"engines": {
"vscode": "^1.38.0"
},
"bugs": {
"url": "https://github.com/CER10TY/hncode2/issues",
"email": "[email protected]"
},
"categories": [
"Other"
],
"repository": {
"type": "git",
"url": "https://github.com/cer10ty/hncode2.git"
},
"activationEvents": [
"onView:top-stories",
"onView:ask-hn"
Expand Down

0 comments on commit 8ee00b8

Please sign in to comment.