eznix86/readme
1
0
Fork 0
mirror of https://github.com/eznix86/readme.git synced 2026-07-26 13:39:03 +00:00
Code Issues Projects Packages Wiki Activity
Utility app to display quickly README.md files from terminal
5 commits 1 branch 0 tags 72 KiB
Find a file
Exact
Bernard Joseph Jean Bruno 35513f049b
 Merge pull request #4 from christophevolbert/new_repo 
new repo in README file
2018-11-17 01:50:48 +04:00
contributors.md Added contributors.md 2018-10-20 00:24:52 +04:00
new_version.txt new repo in README file 2018-11-17 01:42:18 +04:00
README.md Update readme.md 2018-10-20 00:31:04 +04:00

README.md

readme

Utility app to display quickly README.md files from terminal

Usage

  • To open README.md in a readable format from terminal
readme README.md

To do

  • open readme app from terminal or double click on file readme.md to trigger the app
  • Able to send content of readme.md into electronJS
  • Convert readme.md contents (github markdown) into html
  • display html file on electronjs renderer

Optional

  • Quick edit of markdown
  • Easy way to add tags
  • Quick github markdown templates

Don't forget to append your information in the contributors.md

  • Name
  • Github username
  • Public social media account (if any)