Add badges to README

vnegi10 · Jul 25, 2021 · c5a7355 · c5a7355 · vnegi10 · Jul 25, 2021
1 parent 349df37
commit c5a7355
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # CryptoDashApp.jl
 
+[![Build status (Github Actions)](https://github.com/vnegi10/CryptoDashApp.jl/workflows/CI/badge.svg)](https://github.com/vnegi10/CryptoDashApp.jl/actions)
+
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://vnegi10.github.io/CryptoDashApp.jl/stable)
+
 Interactive visualization of historical price, health metrics, candlestick and volume data for various cryptocurrencies. Data are obtained via API queries to Alpha Vantage. 
 The app is written in Julia and makes use of Dash.jl along with its react framework to generate a dashboard style view accessible via a browser. 
 Different moving averages are also calculated and plotted along with the daily average price data. Averaging window can be selected by the user.
@@ -20,7 +24,9 @@ Once all the packages are downloaded, you can make use of the **CryptoDashApp**
 ```julia
 julia> using CryptoDashApp
 julia> run_app(8056, "your key") # where 8056 is the port
-```    
+```  
+
+Free API key can be obtained from [here.](https://www.alphavantage.co/support/#api-key)
 
 Now, open a new tab in your browser and check if you can access http://0.0.0.0:8056/ or http://127.0.0.1:8056/