Code Monkey home page Code Monkey logo

mkproject's Introduction

mkreadme

mkreadme is a CLI that asks you some questions about your project and creates a beautiful reamde with this information. The basic structure of a beautiful readme is taken from Make a Readme by Danny Guo.

GitHub Workflow Status GitHub package.json version npm

TODO: demo with asciinema

Installation

You can install the CLI globally with npm as a node package:

npm install mkreadme -g

Usage

If you installed the CLI with the global flag, you can use it from anywhere on your system:

mkreadme

Support

If you have any problems using this tool or feature reqeusts, please feel free to open an issue.

Roadmap

MVP

  • one
  • two

1.0.0

  • Demo with asciinema ✅
  • Important badges

Contributing

You are welcome to contribute and make pull requests. If you want to introduce a new bigger feature you can open an issue to discuss it.

Authors and acknowledgement

License

GNU GPLv3

Project status

Working on version 1.0

mkproject's People

Contributors

ityreh avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.