diff --git a/README.md b/README.md index a9c8f15..b032904 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,34 @@ -Pyramid CSharp RS-232 API +Pyramid C# .NET RS-232 API ========================= -This the alpha release of the C# port of the Pyramid Java Library, -It is not 100% tested but we're working on it. Please report bugs and feature requests so we can bring this to an official release. +Overview +-------- +This library is for OEMs and software developers looking to quickly and easily integrate an RS-232 bill validator +into their system. Get up and running quickly without having to worry about the low-level bit twiddling. +## Important +If you are using an Apex 7000 or Spectra, please make sure that all of your dip switches are in the off position. The unit msust be in RS-232 mode to use this library. For more information about configuration, please see our [faq](http://pyramidacceptors.com/support/faq/). +## C# .NET Pyramid Device API + +* Windows .NET 3.5 Runtime +* Supports Escrow Mode +* Highly Configurable +* Very lightweight library (small dll and low memory consumption) + +### Dependencies if you prefer to not use Gradle + +* [log4net](https://www.nuget.org/packages/log4net/1.2.10) + +### Troubleshooting + +Mono runtime is untested and folks on Unity may have trouble. We're investigating workarounds and hoping to support Mono. That of course, is dependent on serial port support. + +### License ### + +[This library is available under the MIT license](https://opensource.org/licenses/MIT) + +### Contribution guidelines ### + +We warmly welcome pull requests, feature requests, and any other feedback you are willing to offer.