From 13443517910133ecd9a23b52b3619523dc3c1c8f Mon Sep 17 00:00:00 2001 From: Eugene Sokolov Date: Sat, 10 Oct 2020 14:04:01 +0300 Subject: docs: update README.md --- README.md | 39 +++++++++++++++------------------------ 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 902f6f2..f2473c4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@

BENZIN

-[React](https://reactjs.org/) Material components library. It supplies you with cool pre-defined style, while assuring that your project will follow all [Material Design guidelines](https://material.io/). - -[![](https://img.shields.io/npm/v/react-benzin?logo=npm)](https://github.com/eug-vs/react-benzin/releases) -[![](https://img.shields.io/circleci/build/github/eug-vs/react-benzin?logo=circleci)](https://github.com/eug-vs/react-benzin/commits/develop) -[![](https://img.shields.io/david/eug-vs/react-benzin)](https://github.com/eug-vs/react-benzin/network/dependencies) -[![](https://img.shields.io/github/languages/code-size/eug-vs/react-benzin)](https://github.com/eug-vs/react-benzin/releases) -[![](https://img.shields.io/npm/l/react-benzin)](https://github.com/eug-vs/react-benzin/blob/develop/LICENSE.md) - +

+ React Material library for content-display featuring Markdown rendering. +

+

+ + + + + +

# Getting started ## Installation @@ -16,26 +18,15 @@ You can easily add **BENZIN** to your project with `npm`: ```bash $ npm install react-benzin ``` -**BENZIN** works best in kick-starting new projects and allows you to focus on the functionality, while all the beauty will be maintained by our library. - -**TIP:** *Create-React-App with Typescript* is your GO-TO in most of the cases. [Learn more.](https://create-react-app.dev/docs/adding-typescript/) +**TIP:** **BENZIN** is designed to work in Material-UI environment, so it's best to use them together: +```bash +$ npm @material-ui/core +``` -![Preview screenshot](https://user-images.githubusercontent.com/51545008/73991116-46b04f00-495c-11ea-9733-865bcc6c8807.png) +![Preview screenshot](https://user-images.githubusercontent.com/51545008/95653266-209d0900-0b00-11eb-9a0a-f3aa81c878e5.png) You can find a minimal usage example [here](src/index.tsx). -## Functionality -**BENZIN** provides you with a bunch of cool components that greatly integrate with each other. - -[Explore](src/lib) `src/lib/` folder to see what's available. Documentation is yet to come, but for now you can enjoy type definitons. - -[Chrono-Cube](https://github.com/eug-vs/chrono-cube/) will also be a great example of usage, since it's the actual project which inspired us to create **BENZIN**. - - -# Explore NPM package online -https://www.npmjs.com/package/react-benzin - - # Development ## Running live demo To run a live example, clone a repo and execute following commands: -- cgit v1.2.3