diff --git a/README.md b/README.md index c6694ef..a2e291f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,35 @@ -
npm package name : interactive-iran-map
-
+
+  # interactive-iran-map · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alithecodeguy/interactive-iran-map/blob/master/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](https://github.com/alithecodeguy/interactive-iran-map/compare)
+
+

+

+ + +
+

+ Interactive Iran map for react that can shows any kind of data - suitable for BI activities. Alpha version uploaded. The code itself is straightforward but the documents comming soon. -
-

I used CRA to create this package for the moment but it's going to be a pure module any time soon

+ +## Getting started + + `$ npm i interactive-iran-map` + + +## Notice +I used CRA to create this package for the moment but it's going to be a pure module any time soon

نقشه تعاملی ایران در ریکت - مناسب برای کارهای آماری و نمایش انواع داده

نسخه آلفا بارگذاری شد.

با مطالعه کد نحوه کار کردن آن را متوجه خواهید شد با اینحال به زودی مستندات آن منتشر می شود

در حال حاضر از CRA برای ساخت این پکیج استفاده شده است اما در نسخه های بعد به شکل یک ماژول مستقل اراپه خواهد شد

-![alt text](./InteractiveIranMap1.gif) +## Contributing + +Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request. + + +## License -![alt text](./InteractiveIranMap2.gif) +This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/alithecodeguy/interactive-iran-map/blob/master/LICENSE) file for details