From 479c7ca969a197f86cb9b98761bd4f785299985f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E6=98=8E?= <2534290808@qq.com> Date: Thu, 10 Jan 2019 15:29:48 +0800 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1b07eaa..c172a64 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # flutter_icons +[![pub package](https://img.shields.io/pub/v/flutter_icons.svg)](https://pub.dartlang.org/packages/flutter_icons) + Customizable Icons for Flutter,Inspired by react-native-vector-icons ## Notice This project is under development, there is no stable version at present, we do not recommend you to use in production for the time being, welcome everyone to contribute code. -## Getting Started +## Usage +To use this plugin, add `flutter_icons` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). + +## Example -This project is a starting point for a Dart -[package](https://flutter.io/developing-packages/), -a library module containing code that can be shared easily across -multiple Flutter or Dart projects. +``` dart +// Import package +import 'package:flutter_icons/flutter_icons.dart'; +import 'package:flutter/material.dart'; -For help getting started with Flutter, view our -[online documentation](https://flutter.io/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +Icon(icon:Ionicons.ios_search); +Icon(icon:AntDesign.stepForward); +``` +##### More Icons will be added later , welcome everyone to contribute code.