first commit

READMEog.md

@@ -0,0 +1,34 @@
+# Overlay.NET
+
+## Synopsis
+
+Overlay.NET aims to be An easy-to-use overlay library that allows you to render visuals to other windows, and offers lots of overlay options, from external WPF windows to shared process directx hooks to do the overlay rendering. 
+
+
+
+## NuGet: https://www.nuget.org/packages/Overlay.NET/
+
+## Features 
+- WPF based overlay.
+- Directx based overlay.
+- DirectX code is 99% from this project, check it out if interested in dx based overlays - https://github.com/michel-pi/GameOverlay.Net
+- Soon: Shared process, or 'in-process' directX engine to use the games directx device instead.
+
+## Demos / Examples
+You may find the demo code here: https://github.com/lolp1/Overlay.NET/tree/master/src/Overlay.NET.Demo
+
+You may view a quick demo video of the WPF/directx overlay below.
+
+<a href="https://www.youtube.com/watch?v=HN7cdjoMZxc
+" target="_blank"><img src="http://img.youtube.com/vi/aq6LG3IML7s/0.jpg" 
+alt="Overlay demo" width="300" height="200" border="10" /></a>
+
+## Contributing (please do!)
+- If you like it, star it. 
+- If you love it, contribute. 
+- If you want to add to the sample/demo apps, include a working example in your pull request, preferably added to the demo project.
+
+## Credits
+- Julian Forrester aka Arcanaeum for showing me how to make a basic wpf overlay.
+- https://github.com/michel-pi/GameOverlay.Net - The external directx2D overlay implementation.
+- xaviermonin (https://github.com/xaviermonin) - fixed the most annoying directx overlay bug for the creators window update.