From c5820eff76335afb4951844da22843f33f820ba4 Mon Sep 17 00:00:00 2001 From: Hex Date: Tue, 7 Mar 2017 18:57:55 -0500 Subject: [PATCH] threw together a quick readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bf0c83 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# TCPGeckoSharp +.NET assembly that lets you access and use TCPGecko. + +## How to use +- Download from [here](https://github.com/ASHTeam/TCPGeckoSharp/releases/latest) +- Add the reference to your project +- Add `using TCPGeckoSharp;` to the list of assembly(s) used by your project +- Declare it by using `public TCPGecko gecko;` and `gecko = new TCPGecko("ip here", 7331);` +- Connect to the console using `gecko.Connect();` and disconnect using `gecko.Disconnect();` + +## Compiling +- Get VS +- Download this source +- Open this in VS +- Go to Build tab +- Click Build Solution