meread

Readme templating engine

Usage no npm install needed!

<script type="module">
  import meread from 'https://cdn.skypack.dev/meread';
</script>

README


logo
Make your README's suck less using meread's templating.


demo

Version number meread templated MIT Licensed


Installation

npm install -g meread

Usage

meread

Motivation

Engineers are famous for being entirely focused on the hack. From the technical implementation to pounding out the code, README files are often forgotten. When others want to see and learn from your code they head to your README file. Without loving, it is probably a mess.

Use meread to make quick and clean readme files. Have a designer build the template or just stick to the prebuilt template we provide in order to get your information out to an audience in a presentable way!


Changelog

  • 0.*.*-prelaunch: Prelaunch Beta Testing