Browse Source

Adjust readme file

Helen Tran 10 years ago
parent
commit
ecccd7a367
2 changed files with 8 additions and 13 deletions
  1. 1 0
      _layouts/index.html
  2. 7 13
      index.md

+ 1 - 0
_layouts/index.html

@@ -24,6 +24,7 @@
           <h1 class="hero-logo">{{ site.github.project_title }}</h1>
           <h2 class="hero-text">{{ site.github.project_tagline }}</h2>
           <div class="cta-buttons">
+            <a href="http://godoc.org/github.com/Shopify/sarama" class="float">Documentation</a>
             <a href="{{ site.github.zip_url }}" class="float">Download ZIP</a>
             <a href="{{ site.github.repository_url }}" class="float github">
               Github Repo

+ 7 - 13
index.md

@@ -2,21 +2,15 @@
 layout: index
 ---
 
-sarama
-======
+Sarama is an MIT-licensed Go client library for Apache Kafka 0.8 (and later). It is compatible with Go 1.1 and 1.2 (which means `go vet` on 1.2 may return some suggestions that we are ignoring for the sake of compatibility with 1.1).
 
-Sarama is an MIT-licensed Go client library for Apache Kafka 0.8 (and later).
+A word of warning: the API is not 100% stable yet. It won't change much (in particular the low-level Broker and Request/Response objects could *probably* be considered frozen) but there may be the occasional parameter added or function renamed. As far as semantic versioning is concerned, we haven't quite hit 1.0.0 yet. It is absolutely stable enough to use, just expect that you might have to tweak things when you update to a newer version.
 
-Documentation is available via godoc at http://godoc.org/github.com/Shopify/sarama
+Other related links:
 
-It is compatible with Go 1.1 and 1.2 (which means `go vet` on 1.2 may return
-some suggestions that we are ignoring for the sake of compatibility with 1.1).
+* https://kafka.apache.org
+* https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol
 
-A word of warning: the API is not 100% stable yet. It won't change much (in particular the low-level
-Broker and Request/Response objects could *probably* be considered frozen) but there may be the occasional
-parameter added or function renamed. As far as semantic versioning is concerned, we haven't quite hit 1.0.0 yet.
-It is absolutely stable enough to use, just expect that you might have to tweak things when you update to a newer version.
+## License
 
-Other related links:
-* https://kafka.apache.org/
-* https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol
+Copyright (c) 2013 Shopify | Released under the [MIT-LICENSE](http://opensource.org/licenses/MIT)