diff --git a/README.md b/README.md new file mode 100644 index 00000000..0326ac18 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +#TradingView Charting Library + + +This repository contains Charting Library package. If you use Git in your project, please feel free to this repo as a submodule to your one. `master` branch contains current stable version. `dev` branch contains the most recent features and fixes, but it's less stable. + +###Documentation +See our docs @ this repository's [wiki](https://github.com/tradingview/charting_library/wiki). Please read it (at least, [Overview](https://github.com/tradingview/charting_library/wiki) and [Best Practices](https://github.com/tradingview/charting_library/wiki/Best-practices)) before running the Library. + +###Issues Tracking +We use GitHub [Issues tracker](https://github.com/tradingview/charting_library/issues) for our project. Feel free to create bug reports and features requests. Please try reading the doc before asking questions because we will have more time for development then.