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 * [Artemis](https://activemq.apache.org/artemis/)
  43
  44 See the tests for **relevant environment variables**.
  45
  46 **NOTE:** For testing with rabbitmq, you also need `export STOMP_RMQ="/"` due to the default vhost of rabbitmq is "/" instead of "localhost".
  47
  48 ## Contributions ##
  49
  50 Any and all are welcome by pull request or e-mail patch.
  51
  52 ## Wiki ##
  53
  54 News and notes will be posted from time to time at the stompngo wiki:
  55
  56 * [stompngo wiki](https://github.com/gmallard/stompngo/wiki)
  57
  58 Please review and update that on occaision.
  59
  60 ## Canonical Repository ##
  61
  62 For the record, the canonical repository for this project is at:
  63
  64 * [stompngo at github](https://github.com/gmallard/stompngo)
  65
  66 ## Issues ##
  67
  68 Please review issues at the canonical repository.  File any new issues there as
  69 well:
  70
  71 * [issues](https://github.com/gmallard/stompngo/issues?sort=comments&state=open)
  72
  73 ## Contributors (by first author date) ##
  74
  75 Contribution information (maintained semiautomatically, best efforts basis):
  76
  77 <table border="1" style="width:100%;border: 1px solid black;">
  78 <tr>
  79 <th style="border: 1px solid black;padding-left: 10px;" >
  80 First Author Date
  81 </th>
  82 <th style="border: 1px solid black;padding-left: 10px;" >
  83 (Commit Count)
  84 </th>
  85 <th style="border: 1px solid black;padding-left: 10px;" >
  86 Name / E-mail
  87 </th>
  88 </tr>
  89 <tr>
  90 <td style="border: 1px solid black;padding-left: 10px;" >
  91 2011-10-10
  92 </td>
  93 <td style="border: 1px solid black;padding-left: 10px;" >
  94 (0240)
  95 </td>
  96 <td style="border: 1px solid black;padding-left: 10px;" >
  97 <span style="font-weight: bold;" >
  98 gmallard
  99 </span>
 100  / &lt;allard.guy.m@gmail.com&gt;
 101 </td>
 102 </tr>
 103 <tr>
 104 <td style="border: 1px solid black;padding-left: 10px;" >
 105 2014-02-02
 106 </td>
 107 <td style="border: 1px solid black;padding-left: 10px;" >
 108 (0001)
 109 </td>
 110 <td style="border: 1px solid black;padding-left: 10px;" >
 111 <span style="font-weight: bold;" >
 112 Kelsey Hightower
 113 </span>
 114  / &lt;kelsey.hightower@gmail.com&gt;
 115 </td>
 116 </tr>
 117 <tr>
 118 <td style="border: 1px solid black;padding-left: 10px;" >
 119 2014-12-12
 120 </td>
 121 <td style="border: 1px solid black;padding-left: 10px;" >
 122 (0001)
 123 </td>
 124 <td style="border: 1px solid black;padding-left: 10px;" >
 125 <span style="font-weight: bold;" >
 126 Logan Attwood
 127 </span>
 128  / &lt;logan@therounds.ca&gt;
 129 </td>
 130 </tr>
 131 <tr>
 132 <td style="border: 1px solid black;padding-left: 10px;" >
 133 2015-04-16
 134 </td>
 135 <td style="border: 1px solid black;padding-left: 10px;" >
 136 (0002)
 137 </td>
 138 <td style="border: 1px solid black;padding-left: 10px;" >
 139 <span style="font-weight: bold;" >
 140 Max Garvey
 141 </span>
 142  / &lt;mgarvey@monsooncommerce.com&gt;
 143 </td>
 144 </tr>
 145 <tr>
 146 <td style="border: 1px solid black;padding-left: 10px;" >
 147 2016-04-11
 148 </td>
 149 <td style="border: 1px solid black;padding-left: 10px;" >
 150 (0001)
 151 </td>
 152 <td style="border: 1px solid black;padding-left: 10px;" >
 153 <span style="font-weight: bold;" >
 154 Joakim Sernbrant
 155 </span>
 156  / &lt;joakim.sernbrant@trioptima.com&gt;
 157 </td>
 158 </tr>
 159 <tr>
 160 <td style="border: 1px solid black;padding-left: 10px;" >
 161 2016-07-30
 162 </td>
 163 <td style="border: 1px solid black;padding-left: 10px;" >
 164 (0120)
 165 </td>
 166 <td style="border: 1px solid black;padding-left: 10px;" >
 167 <span style="font-weight: bold;" >
 168 Guy M. Allard
 169 </span>
 170  / &lt;allard.guy.m@gmail.com&gt;
 171 </td>
 172 </tr>
 173 <tr>
 174 <td style="border: 1px solid black;padding-left: 10px;" >
 175 2017-03-01
 176 </td>
 177 <td style="border: 1px solid black;padding-left: 10px;" >
 178 (0001)
 179 </td>
 180 <td style="border: 1px solid black;padding-left: 10px;" >
 181 <span style="font-weight: bold;" >
 182 Dan Corin
 183 </span>
 184  / &lt;danielcorin@users.noreply.github.com&gt;
 185 </td>
 186 </tr>
 187 <tr>
 188 <td style="border: 1px solid black;padding-left: 10px;" >
 189 2017-05-05
 190 </td>
 191 <td style="border: 1px solid black;padding-left: 10px;" >
 192 (0001)
 193 </td>
 194 <td style="border: 1px solid black;padding-left: 10px;" >
 195 <span style="font-weight: bold;" >
 196 Jason Libbey
 197 </span>
 198  / &lt;jlibbey@uber.com&gt;
 199 </td>
 200 </tr>
 201 <tr>
 202 <td style="border: 1px solid black;padding-left: 10px;" >
 203 2017-06-05
 204 </td>
 205 <td style="border: 1px solid black;padding-left: 10px;" >
 206 (0001)
 207 </td>
 208 <td style="border: 1px solid black;padding-left: 10px;" >
 209 <span style="font-weight: bold;" >
 210 Dan Corin
 211 </span>
 212  / &lt;dancorin@uber.com&gt;
 213 </td>
 214 </tr>
 215 <tr>
 216 <td style="border: 1px solid black;padding-left: 10px;" >
 217 2017-11-06
 218 </td>
 219 <td style="border: 1px solid black;padding-left: 10px;" >
 220 (0006)
 221 </td>
 222 <td style="border: 1px solid black;padding-left: 10px;" >
 223 <span style="font-weight: bold;" >
 224 tomsawyer
 225 </span>
 226  / &lt;tomsawyer126@gmail.com&gt;
 227 </td>
 228 </tr>
 229 <tr>
 230 <td style="border: 1px solid black;padding-left: 10px;" >
 231 2017-11-20
 232 </td>
 233 <td style="border: 1px solid black;padding-left: 10px;" >
 234 (0001)
 235 </td>
 236 <td style="border: 1px solid black;padding-left: 10px;" >
 237 <span style="font-weight: bold;" >
 238 itomsawyer
 239 </span>
 240  / &lt;tomsawyer126@gmail.com&gt;
 241 </td>
 242 </tr>
 243 <tr>
 244 <td style="border: 1px solid black;padding-left: 10px;" >
 245 2018-03-12
 246 </td>
 247 <td style="border: 1px solid black;padding-left: 10px;" >
 248 (0001)
 249 </td>
 250 <td style="border: 1px solid black;padding-left: 10px;" >
 251 <span style="font-weight: bold;" >
 252 GAOXIANG4
 253 </span>
 254  / &lt;gaoxiang4@kingsoft.com&gt;
 255 </td>
 256 </tr>
 257 </table>