README.md

   1 # stompngo - A STOMP 1.1+ Client Package #
   2
   3 ## Features ##
   4
   5 * Full support of STOMP protocols:
   6
   7     1. [Protocol Level 1.0](http://stomp.github.com/stomp-specification-1.0.html)
   8     2. [Protocol Level 1.1](http://stomp.github.com/stomp-specification-1.1.html)
   9     3. [Protocol Level 1.2](http://stomp.github.com/stomp-specification-1.2.html)
  10
  11 ## References ##
  12
  13 * [STOMP 1.0 Protocol](http://stomp.github.com/stomp-specification-1.0.html)
  14 * [STOMP 1.1 Protocol](http://stomp.github.com/stomp-specification-1.1.html)
  15 * [STOMP 1.2 Protocol](http://stomp.github.com/stomp-specification-1.2.html)
  16
  17 ## Installation ##
  18
  19 Installation requires a working go environment. For current versions of go
  20 issue:
  21
  22 * go get github.com/gmallard/stompngo
  23
  24 The GOPATH environment variable must be set properly.
  25
  26 ## Examples ##
  27
  28 The examples in the included unit tests can be used as a good starting point.
  29
  30 Also see the examples project:
  31
  32 * [stompngo_examples at github](https://github.com/gmallard/stompngo_examples)
  33
  34 ## QA ##
  35
  36 The tests for this STOMP client package run against recent releases of:
  37
  38 * [ActiveMQ](http://activemq.apache.org/)
  39 * [stompserver_ng](https://github.com/gmallard/stompserver_ng)
  40 * [Apache Apollo](http://activemq.apache.org/apollo/)
  41 * [RabbitMQ](http://www.rabbitmq.com/)
  42
  43 See the tests for **relevant environment variables**.
  44
  45 ## Contributions ##
  46
  47 Any and all are welcome by pull request or e-mail patch.
  48
  49 ## Wiki ##
  50
  51 News and notes will be posted from time to time at the stompngo wiki:
  52
  53 * [stompngo wiki](https://github.com/gmallard/stompngo/wiki)
  54
  55 Please review and update that on occaision.
  56
  57 ## Canonical Repository ##
  58
  59 For the record, the canonical repository for this project is at:
  60
  61 * [stompngo at github](https://github.com/gmallard/stompngo)
  62
  63 ## Issues ##
  64
  65 Please review issues at the canonical repository.  File any new issues there as
  66 well:
  67
  68 * [issues](https://github.com/gmallard/stompngo/issues?sort=comments&state=open)
  69
  70 ## Contributors (by first author date) ##
  71
  72 Contribution information (maintained semiautomatically, best efforts basis):
  73
  74 <table border="1" style="width:100%;border: 1px solid black;">
  75 <tr>
  76 <th style="border: 1px solid black;padding-left: 10px;" >
  77 First Author Date
  78 </th>
  79 <th style="border: 1px solid black;padding-left: 10px;" >
  80 (Commit Count)
  81 </th>
  82 <th style="border: 1px solid black;padding-left: 10px;" >
  83 Name / E-mail
  84 </th>
  85 </tr>
  86 <tr>
  87 <td style="border: 1px solid black;padding-left: 10px;" >
  88 2011-10-10
  89 </td>
  90 <td style="border: 1px solid black;padding-left: 10px;" >
  91 (0251)
  92 </td>
  93 <td style="border: 1px solid black;padding-left: 10px;" >
  94 <span style="font-weight: bold;" >
  95 gmallard
  96 </span>
  97  / allard.guy.m@gmail.com
  98 </td>
  99 </tr>
 100 <tr>
 101 <td style="border: 1px solid black;padding-left: 10px;" >
 102 2014-02-02
 103 </td>
 104 <td style="border: 1px solid black;padding-left: 10px;" >
 105 (0001)
 106 </td>
 107 <td style="border: 1px solid black;padding-left: 10px;" >
 108 <span style="font-weight: bold;" >
 109 Kelsey Hightower
 110 </span>
 111  / kelsey.hightower@gmail.com
 112 </td>
 113 </tr>
 114 <tr>
 115 <td style="border: 1px solid black;padding-left: 10px;" >
 116 2014-02-03
 117 </td>
 118 <td style="border: 1px solid black;padding-left: 10px;" >
 119 (0075)
 120 </td>
 121 <td style="border: 1px solid black;padding-left: 10px;" >
 122 <span style="font-weight: bold;" >
 123 Guy M. Allard
 124 </span>
 125  / allard.guy.m@gmail.com
 126 </td>
 127 </tr>
 128 <tr>
 129 <td style="border: 1px solid black;padding-left: 10px;" >
 130 2014-12-12
 131 </td>
 132 <td style="border: 1px solid black;padding-left: 10px;" >
 133 (0001)
 134 </td>
 135 <td style="border: 1px solid black;padding-left: 10px;" >
 136 <span style="font-weight: bold;" >
 137 Logan Attwood
 138 </span>
 139  / logan@therounds.ca
 140 </td>
 141 </tr>
 142 <tr>
 143 <td style="border: 1px solid black;padding-left: 10px;" >
 144 2015-04-16
 145 </td>
 146 <td style="border: 1px solid black;padding-left: 10px;" >
 147 (0002)
 148 </td>
 149 <td style="border: 1px solid black;padding-left: 10px;" >
 150 <span style="font-weight: bold;" >
 151 Max Garvey
 152 </span>
 153  / mgarvey@monsooncommerce.com
 154 </td>
 155 </tr>
 156 <tr>
 157 <td style="border: 1px solid black;padding-left: 10px;" >
 158 2016-04-11
 159 </td>
 160 <td style="border: 1px solid black;padding-left: 10px;" >
 161 (0001)
 162 </td>
 163 <td style="border: 1px solid black;padding-left: 10px;" >
 164 <span style="font-weight: bold;" >
 165 Joakim Sernbrant
 166 </span>
 167  / joakim.sernbrant@trioptima.com
 168 </td>
 169 </tr>
 170 <tr>
 171 <td style="border: 1px solid black;padding-left: 10px;" >
 172 2017-03-01
 173 </td>
 174 <td style="border: 1px solid black;padding-left: 10px;" >
 175 (0001)
 176 </td>
 177 <td style="border: 1px solid black;padding-left: 10px;" >
 178 <span style="font-weight: bold;" >
 179 Daniel Corin
 180 </span>
 181  / danielcorin@users.noreply.github.com
 182 </td>
 183 </tr>
 184 </table>