Create README.md

Added readme file to repo on github
This commit is contained in:
Ben Merrills 2015-01-02 19:05:49 +00:00
parent afc7f39b04
commit 19d1fdf418

30
README.md Normal file
View file

@ -0,0 +1,30 @@
AsterNET is an open source framework for Asterisk AMI and FastAGI. AsterNET allows you to talk to Asterisk AMI from any .NET application and create FastAGI applications in any .NET language.
## Components
AsterNET is made up of two key components, FastAGI and Manager Interface. Each allows you to interact with Asterisk in different ways. FastAGI allows you to control the flow of a call from another machine (a dedicated AGI server for example) and Manager Interface allows you to obtain state information and interact with Asterisk.
## AsterNET on IRC
Join in the conversation on Freenode, #asternet
## How to Get AsterNET
You can now get AsterNET via nuget by doing
> PM> Install-Package AsterNET
or by visiting: https://www.nuget.org/packages/AsterNET/
## The AGI Gallery
We want the community to share as much as possible, so if you've written an AGI that is either commercial or general purpose, then why not list if on http://www.theagigallery.co.uk. This site has been setup to allow developers to share their creations, open or closed source.
## Blog
You can read about AsterNET and related projects at my blog www.xdev.net. I'll post about AsterNET and related subjects as well as samples I'm working on. Feel free to check it out. Or follow me on twitter (@benjmerrills) to get involved.
## History
AsterNET is a fork of Asterisk.NET. Now we've reached release status and AsterNET version 1.0.0 we feel this is a good separation point from the original project.
There are 2 reasons I have renamed it to AsterNET on codeplex. Asterisk .NET was taken. It will help separate the project from the original codeplex project- in case the guys come back. And keep AsterNET as the new revived project. So it will stop confusing links on search engines, and sharing.
*Special Thanks*
http://www.zapappi.com and http://www.jetbrains.com/resharper/
We'd like to thank JetBrains for our community licenses of ReShaper. A very useful tool that's helping us to refactor the code and improve general development much quicker. If you'd like to try it yourself, visit http://www.jetbrains.com