Skip to content

Commit

Permalink
docs: update getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
fraxken authored Mar 20, 2020
1 parent d788c8f commit e213ad8
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
![size](https://img.shields.io/github/languages/code-size/SlimIO/Generator.svg)
[![Known Vulnerabilities](https://snyk.io//test/github/SlimIO/Generator/badge.svg?targetFile=package.json)](https://snyk.io//test/github/SlimIO/Generator?targetFile=package.json)
[![Build Status](https://travis-ci.com/SlimIO/Generator.svg?branch=master)](https://travis-ci.com/SlimIO/Generator)
[![Greenkeeper badge](https://badges.greenkeeper.io/SlimIO/Generator.svg)](https://greenkeeper.io/)

SlimIO Project Generator. This project has been created to help SlimIO contributors **to generate new project without to have to worry** about required files and configuration (as required by the Governance and psp policies).

Expand All @@ -18,12 +17,12 @@ SlimIO Project Generator. This project has been created to help SlimIO contribut
- [Node.js](https://nodejs.org/en/) v12 or higher

## Getting Started
This package is available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com).

```bash
$ npm i @slimio/generator
# or
$ yarn add @slimio/generator
$ git clone https://github.com/SlimIO/Generator.git
$ cd Generator
$ npm ci
$ npm link
```

## Usage example
Expand Down

0 comments on commit e213ad8

Please sign in to comment.