Skip to content

Commit

Permalink
customized the readme, added logo and ref to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jordan-Eckowitz committed Feb 20, 2021
1 parent 74a5942 commit 97e5112
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
boil-cli-tool
=============
# About

CLI tool for generating boilerplate files and folders
<img src="./boil-logo.svg" height="60" />

A boilerplate template manager and generator

**Check out the full documentation here:** https://jordan-eckowitz.github.io/boil-cli-docs

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/boil-cli-tool.svg)](https://npmjs.org/package/boil-cli-tool)
[![Downloads/week](https://img.shields.io/npm/dw/boil-cli-tool.svg)](https://npmjs.org/package/boil-cli-tool)
[![License](https://img.shields.io/npm/l/boil-cli-tool.svg)](https://github.com/Jordan-Eckowitz/boil-cli/blob/master/package.json)

<!-- toc -->
* [About](#about)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g boil-cli-tool
Expand All @@ -26,7 +32,9 @@ USAGE
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`boil create [NAME]`](#boil-create-name)
* [`boil create-function [NAME]`](#boil-create-function-name)
Expand Down
33 changes: 33 additions & 0 deletions boil-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 97e5112

Please sign in to comment.