Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
nitayneeman committed Aug 2, 2019
1 parent aad84ee commit 9cf6540
Showing 1 changed file with 30 additions and 9 deletions.
39 changes: 30 additions & 9 deletions README.md
@@ -1,26 +1,39 @@
# Schematics Utilities
<h1 align="center">Schematics Utilities</h1>

[![npm](https://img.shields.io/npm/v/schematics-utilities.svg?colorB=brightgreen)](https://www.npmjs.com/package/schematics-utilities)
[![Package Version](https://img.shields.io/github/package-json/v/nitayneeman/schematics-utilities.svg)](https://github.com/nitayneeman/schematics-utilities)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nitayneeman/schematics-utilities/blob/master/LICENSE)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![docs: typedoc](https://img.shields.io/badge/docs-typedoc-4D0080.svg)](https://nitayneeman.github.io/schematics-utilities/)
<p align="center">
<a href="https://www.npmjs.com/package/schematics-utilities"><img src="https://img.shields.io/npm/v/schematics-utilities.svg?colorB=cb3837" alt="npm"></a>
<a href="https://nitayneeman.github.io/schematics-utilities/"><img src="https://img.shields.io/badge/docs-typedoc-green.svg" alt="Docs"></a>
<a href="https://www.npmjs.com/package/schematics-utilities"><img src="https://img.shields.io/npm/dt/schematics-utilities?color=blue" alt="Downloads"></a>
<a href="https://github.com/nitayneeman/schematics-utilities/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-lightgray.svg" alt="License"></a>
</p>

<p align="center">
<a href="https://github.com/nitayneeman/schematics-utilities#how-to-install">Installation</a> ·
<a href="https://github.com/nitayneeman/schematics-utilities#how-to-use">Usage</a> ·
<a href="https://github.com/nitayneeman/schematics-utilities#disclaimer">Disclaimer</a>
</p>

## ℹ️️ Description

At the moment, none of the utilities from the Angular Schematics package are exported.

This project was created from that purpose - _providing a collection of general and useful utilities for Schematics, based on non-exported existing utilities and further_.

You might use this project as a polyfill until these utilities will be exported officially by the relevant teams (and then just replace the path you import). However, consider sticking with this project for additional and unique utilities which are planned for the future.

## How to Install
<br>

## 🔧 How to Install

To Install using npm, simply do:

```
npm install schematics-utilities
```

## How to Use
<br>

## 👨🏻‍🏫 How to Use

```javascript
import { Rule, Tree } from '@angular-devkit/schematics';
Expand All @@ -47,11 +60,19 @@ export default function(): Rule {

Check out the [API docs](https://nitayneeman.github.io/schematics-utilities/) for the available utilities.

## Disclaimer
<br>

## ⚠️️ Disclaimer

This repository contains code which is directly taken from:

- [Angular Schematics package](https://github.com/angular/angular-cli/tree/master/packages/schematics)
- [Angular Material](https://github.com/angular/components/tree/master/src/cdk/schematics/utils)

All credits go to the respective developers! 👏

<br>

## 💁🏻 Contributing

This is an open source project. Any contribution would be greatly appreciated!

0 comments on commit 9cf6540

Please sign in to comment.