Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 2.23 KB

README.md

File metadata and controls

77 lines (59 loc) · 2.23 KB


Cedar

Build beautiful console applications.


Installation · Docs · API



Latest Version Monthly downloads

Follow @marcuspoehls and @superchargejs for updates!


Introduction

The @supercharge/cedar package allows you to create beautiful console applications.

Installation

npm i @supercharge/cedar

Docs

Find all the details for @supercharge/cedar in the extensive Supercharge docs.

Usage

Using @supercharge/cedar is pretty straightforward. The package exports a handful of methods that you can reach for when requiring the package:

const { Application } = require('@supercharge/cedar')

async function run () {
  const app = new Application('console-app-name')
  await app.run()
}

Contributing

Do you miss a function? We very much appreciate your contribution! Please send in a pull request 😊

  1. Create a fork
  2. Create your feature branch: git checkout -b my-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request 🚀

License

MIT © Supercharge


superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs