Skip to content

Commit

Permalink
📖 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tterb committed Nov 2, 2017
1 parent 207504d commit fbb8782
Showing 1 changed file with 31 additions and 27 deletions.
58 changes: 31 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
<p align="left">
<img src="https://user-images.githubusercontent.com/16360374/29169160-6d1c8fbc-7d87-11e7-82dc-d0a1b7078c02.png" height="150"/>
</p>
<h3 align="left">An <a href="http://electron.atom.io" target="_blank"><img src="https://user-images.githubusercontent.com/16360374/27318472-58bebca2-5541-11e7-9870-68d4a4f8f957.png" width="22"/> Electron</a> powered markdown editor for <a href="https://jekyllrb.com" target="_blank"><img src="https://user-images.githubusercontent.com/16360374/29168998-84c8393c-7d86-11e7-943c-50abf259af4e.png" height="23"/>Jekyll</a> users.</h3>
<br>
<p align="right">
[<img alt="Title" height="150" src="https://user-images.githubusercontent.com/16360374/31757195-ba3c3b24-b45c-11e7-8d74-4aef9849c473.png"/>](./README.md)
<br>
<p align="right">
<a href="https://travis-ci.org/JonSn0w/Hyde">
<img src="https://travis-ci.org/JonSn0w/Hyde.svg?branch=master" height="21" title="Build Status"/>&nbsp;
<img alt="Build Status" height="21" src="https://travis-ci.org/JonSn0w/Hyde.svg?branch=master"/>&nbsp;
</a>
<a href="https://www.gnu.org/licenses/">
<img src="https://img.shields.io/badge/License-GPL%20v3-yellow.svg" height="21" title="License"/>&nbsp;
</a>
<a href="https://badge.fury.io/gh/JonSn0w%2FHyde">
<img src="https://badge.fury.io/gh/JonSn0w%2FHyde.svg" height="21" alt="version"/>&nbsp;
</a>
<a href="https://codeclimate.com/github/JonSn0w/Hyde">
<img src="https://codeclimate.com/github/JonSn0w/Hyde/badges/gpa.svg" height="21" alt="Code Climate"/>&nbsp;
<img alt="Code Climate" height="21" src="https://codeclimate.com/github/JonSn0w/Hyde/badges/gpa.svg"/>&nbsp;
</a>
<a href="https://electron.atom.io/">
<img src="https://img.shields.io/badge/powered_by-Electron-blue.svg" height="21" title="Electron"/>&nbsp;
<a href="https://david-dm.org/JonSn0w/Hyde">
<img alt="Dependency Status" height="21" src="https://david-dm.org/JonSn0w/Hyde.svg"/>&nbsp;
</a>
<a href="https://badge.fury.io/gh/JonSn0w%2FHyde">
<img alt="Version" height="21" src="https://badge.fury.io/gh/JonSn0w%2FHyde.svg"/>&nbsp;
</a>
<a href="https://jekyllrb.com/">
<img src="https://img.shields.io/badge/built for-Jekyll-red.svg" height="21" title="Jekyll"/>&nbsp;
<a href="https://www.gnu.org/licenses/">
<img alt="License" height="21" src="https://img.shields.io/badge/License-GPL%20v3-blue.svg"/>&nbsp;
</a>
<!-- <a href="https://electron.atom.io/">
<img src="https://img.shields.io/badge/powered_by-Electron-blue.svg" height="21" title="Electron"/>&nbsp;
</a> -->
</p>

# Description

**Hyde** is an [Electron](http://electron.atom.io)-based markdown editor that aims to improve the accessibility of [Jekyll](https://jekyllrb.com) as a blogging platform for developers and non-developers, alike.
As many users already know, [Jekyll](https://jekyllrb.com) holds many benefits over other blogging platforms. Though, it appears that many potential users outside of the developer community are initially intimidated by the Markdown syntax used to compose and format blog posts.
**Hyde** aims to counter this issue by providing an approachable modular interface, capable of offering the same familiar toolbars and live-preview that you would find in a typical word-processor or the simplicity and streamlined workflow of a minimalistic text editor.

**Hyde** is an [Electron](http://electron.atom.io)-based markdown editor that aims to improve the accessibility of creating beautifully formatted markdown documents for developers and non-developers, alike.
This goal is achieved through an approachable modular interface, capable of offering the same familiar toolbars and live-preview that you would find in a word-processor or the simplicity and streamlined workflow of a minimalistic text editor.
Additionally, while **Hyde** was initially created to cater to [Jekyll](https://jekyllrb.com) users, during development the oppurtunity was recognized to similarly improve the writing experience across various platforms. Therefore, additional features have been integrated that allow Hyde to cater to the wide variety of popular platforms and tools that utilize markdown formatting.

<br>

<p align="center">
<img src="https://user-images.githubusercontent.com/16360374/28510622-4c892968-6ffe-11e7-9944-b5fd30ca9147.png"/>
<img src="https://user-images.githubusercontent.com/16360374/31935237-2bd9f582-b863-11e7-8db8-08e078bf61fd.png"/>
</p>

-------------------------
Expand All @@ -50,13 +49,14 @@ As many users already know, [Jekyll](https://jekyllrb.com) holds many benefits o
* :tada: [Font Awesome](http://fontawesome.io), [Glyphicon](http://glyphicons.com/), and [Emoji](https://www.webpagefx.com/tools/emoji-cheat-sheet/) support :tada:
* Full screen mode
- Write free of all distractions
* Support for [TeX](https://www.latex-project.org/) math rendering
* Integrated spell-checking and word count
* App can remain active in tray for quick access
* All contained within an approachable, modular interface that caters to your workflow
* Cross platform
- Windows, Mac and Linux ready
<br>

<br>

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

Expand Down Expand Up @@ -98,7 +98,11 @@ $ gulp watch

# Contributing

If you're looking for an easy way to contribute to this project but aren't sure where to start, I've created a list of minor bugs and/or issues to be fixed before the projects initial release, which you can find [here](https://github.com/JonSn0w/Hyde/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20is%3Ahelpwanted) or you can just try the app out and [provide some feedback](https://github.com/JonSn0w/Hyde/issues/new).
Also, before submitting a pull-request, I would ask that you first take a look at the projects [Contributing guidelines](https://github.com/JonSn0w/Hyde/blob/master/docs/CONTRIBUTING.md).
If you're looking for an easy way to contribute to this project but aren't sure where to start, I've created a list of minor bugs and/or issues to be fixed before the projects initial release, which you can find [here](https://github.com/JonSn0w/Hyde/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20is%3Ahelpwanted) or you can just try out the app and [provide some feedback](https://github.com/JonSn0w/Hyde/issues/new).
Additionally, if you'd like to submit a pull-request, I would ask that you first take a look at the projects [contributing guidelines](https://github.com/JonSn0w/Hyde/blob/master/docs/CONTRIBUTING.md).

<br>
<br><br>

Proudly powered by:

[<img alt="Electron logo" height="50" src="http://electron.atom.io/images/electron-logo.svg">](http://electron.atom.io/)

0 comments on commit fbb8782

Please sign in to comment.