Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
keshann93 committed Jul 15, 2020
1 parent c4597a7 commit 8cb9427
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 2 deletions.
56 changes: 55 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
# vscode-extension-boilerplate
# vscode-semantic-live

Real-time Preview Enabled [Semantic Live](https://github.com/keshann93/vscode-semantic-live) Composer

## How?

Copy the following Semantic-UI markup to the vscode html extension file.

```html
<div class="ui card">
<div class="image">
<img src="https://semantic-ui.com/images/avatar2/large/kristy.png" />
</div>
<div class="content">
<a class="header">Kristy</a>
<div class="meta">
<span class="date">Joined in 2013</span>
</div>
<div class="description">
Kristy is an art director living in New York.
</div>
</div>
<div class="extra content">
<a>
<i class="user icon"></i>
22 Friends
</a>
</div>
</div>
```

You could copy and paste any [Semantic UI components](https://semantic-ui.com/elements/button.html).

## But Why?

[Semantic UI](https://semantic-ui.com) is an awesome library with excellent components that you can use to quickly
build web interfaces. But I felt like it would be nicer if we can compose bunch of elements and see in realtime how they
fit together. That's why Semantic Edit.

## Features

- Beautifier

## Run & Build from sourcecode

## What's Under the Hood?

JavaScript!

SemanticEdit uses the following

- [Semantic UI](https://semantic-ui.com)
- [React JS](https://facebook.github.io/react/)
- [WebPack Build System](https://webpack.github.io/)
- [Ace Editor](https://ace.c9.io/#nav=about) & [react-ace](https://www.npmjs.com/package/react-ace)
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Help us make Fabulous better
### Help us make semantic-live better

- Install dependencies by executing `yarn install`
- Run webpack dev server by executing `yarn ui`
Expand Down

0 comments on commit 8cb9427

Please sign in to comment.