added doc v1.0

ideepcoder · ideepcoder · commit 69a28689ed43 · 2025-01-01T16:02:06.000+05:30
updated ReadMe
notice file
diff --git a/Docs/WS_RTD_AB.md.html b/Docs/WS_RTD_AB.md.html
diff --git a/Plugin/notice.txt b/Plugin/notice.txt
@@ -0,0 +1,3 @@
+This plugin should be distributed or redisributed with the Documentation
+file provided in HTML that contains all the Licence information,
+Trademark, Copyright & Other notices.
diff --git a/README.md b/README.md
@@ -1,2 +1,29 @@
-# Rtd_Ws_AB_plugin
-AmiBroker data plugin for Websocket based Json RTD communication
+# Rtd_Ws_AB_plugin
+## _AmiBroker Realtime data plugin using Websocket and JSON based communication_
+
+[![Build Status](https://raw.githubusercontent.com/ideepcoder/Rtd_Ws_AB_plugin/84c47468847d2bbf53d2f12fa110d13c041d7b2d/images/unknown.svg)](https://github.com/ideepcoder/Rtd_Ws_AB_plugin)
+
+
+## Features
+- Bi-directional websocket communication
+- Support to backfill historical data
+- Easy to integrate Json message structure
+- Run multiple instances of AmiBroker locally, each connected to one of multiple Servers
+- The design makes it Broker / Data vendor agnostic
+- Runs a python based relay server, to ensure individual connections don't disrupt your flow
+- Build your own data routing logic
+- Store your time-series data in the superfast Amibroker storage database
+- Get you Realtime Quote window ticking as opposed to plain ASCII imports
+
+# ✨ Upcoming  ✨
+- ArcticDB active integration
+- A lot of leverage with keeping bloated data locally in ArcticDB and a concise Amibroker database
+
+
+## Documentation and manual
+### -- Check Docs for the latest documentation
+
+# .
+## Licenses / Copyrights / Trademarks
+##### This work incorporates materials copyrighted and trademarked by Amibroker Company.
+Amibroker and the Amibroker logo are trademarks of Amibroker Company, used with permission.
diff --git a/Samples/Client/Python/notice.txt b/Samples/Client/Python/notice.txt
@@ -0,0 +1,3 @@
+This plugin should be distributed or redisributed with the Documentation
+file provided in HTML that contains all the Licence information,
+Trademark, Copyright & Other notices.
diff --git a/Samples/Server/Python/notice.txt b/Samples/Server/Python/notice.txt
@@ -0,0 +1,3 @@
+This plugin should be distributed or redisributed with the Documentation
+file provided in HTML that contains all the Licence information,
+Trademark, Copyright & Other notices.
diff --git a/images/help/Plugin_Configure.png b/images/help/Plugin_Configure.png

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+This plugin should be distributed or redisributed with the Documentation`
	`2`	`+file provided in HTML that contains all the Licence information,`
	`3`	`+Trademark, Copyright & Other notices.`