Better Readme

master
Mohsen 5 years ago committed by GitHub
parent df2d81bfc4
commit 977cfe463d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 31
      README.md

@ -1,16 +1,35 @@
<pre>npm package name : interactive-iran-map</pre>
<pre> # interactive-iran-map &middot; [![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)
<p align="center">
<div align="center">
<img src="./InteractiveIranMap1.gif" width="250">
<img src="./InteractiveIranMap2.gif" width="250">
</div>
</p>
Interactive Iran map for react that can shows any kind of data - suitable for BI activities. Interactive Iran map for react that can shows any kind of data - suitable for BI activities.
Alpha version uploaded. Alpha version uploaded.
The code itself is straightforward but the documents comming soon. The code itself is straightforward but the documents comming soon.
</pre>
<p>I used CRA to create this package for the moment but it's going to be a pure module any time soon</p> ## 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
<p dir='rtl' align='right'>نقشه تعاملی ایران در ریکت - مناسب برای کارهای آماری و نمایش انواع داده</p> <p dir='rtl' align='right'>نقشه تعاملی ایران در ریکت - مناسب برای کارهای آماری و نمایش انواع داده</p>
<p dir='rtl' align='right'>نسخه آلفا بارگذاری شد.</p> <p dir='rtl' align='right'>نسخه آلفا بارگذاری شد.</p>
<p dir='rtl' align='right'>با مطالعه کد نحوه کار کردن آن را متوجه خواهید شد با اینحال به زودی مستندات آن منتشر می شود</p> <p dir='rtl' align='right'>با مطالعه کد نحوه کار کردن آن را متوجه خواهید شد با اینحال به زودی مستندات آن منتشر می شود</p>
<p dir='rtl' align='right'>در حال حاضر از CRA برای ساخت این پکیج استفاده شده است اما در نسخه های بعد به شکل یک ماژول مستقل اراپه خواهد شد</p> <p dir='rtl' align='right'>در حال حاضر از CRA برای ساخت این پکیج استفاده شده است اما در نسخه های بعد به شکل یک ماژول مستقل اراپه خواهد شد</p>
![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

Loading…
Cancel
Save