Merge pull request elastic#2 from ruflin/docs-update

Update docs and license files to follow other beats standard

CONTRIBUTING.md

@@ -1,65 +1,56 @@
-# Contributing to logstash-forwarder
+# Contributing to Filebeat
 
-All contributions are welcome: ideas, patches, documentation, bug reports,
-complaints, etc!
+Filebeat is an open source project and we love to receive contributions from
+our community — you!
 
-Programming is not a required skill, and there are many ways to help out!
-It is more important to us that you are able to contribute.
+There are many ways to contribute, from writing tutorials
+or blog posts, improving the documentation, submitting bug reports and feature
+requests or writing code for implementing a whole new protocol.
 
-That said, some basic guidelines, which you are free to ignore :)
-
-## Want to learn?
-
-Want to lurk about and see what others are doing with logstash and lumberjack? 
-
-* The irc channel (#logstash on irc.freenode.org) is a good place for this
-* The [mailing list](http://groups.google.com/group/logstash-users) is also
-  great for learning from others.
-
-## Got Questions?
-
-Have a problem or a question?
-
-* You can email the [mailing list](http://groups.google.com/group/logstash-users)
-* alternately, you are welcome to join the IRC channel #logstash on
-irc.freenode.org and ask for help there!
-
-## Have an Idea or Feature Request?
-
-* File a ticket on [github](https://github.com/elasticsearch/logstash-forwarder), or email the
-  [mailing list](http://groups.google.com/group/logstash-users), or email
-  me personally ([email protected]) if that is more comfortable.
-
-## Something Not Working? Found a Bug?
-
-If you think you found a bug, it probably is a bug.
-
-* File it on [github](https://github.com/elasticsearch/logstash-forwarder)
-* or the [mailing list](http://groups.google.com/group/logstash-users).
+If you have a bugfix or new feature that you would like to contribute to
+Filebeat, please start by opening a topic on the
+[forums](https://discuss.elastic.co/c/beats/filebeat). It may be that
+somebody is already working on it, or that there are particular issues that you
+should know about before implementing the change.
 
-# Contributing Documentation and Code Changes
+We enjoy working with contributors to get their code accepted. There are many
+approaches to fixing a problem and it is important to find the best approach
+before writing too much code.
 
-If you have a bugfix or new feature that you would like to contribute to
-logstash, and you think it will take more than a few minutes to produce the fix
-(ie; write code), it is worth discussing the change with the logstash users and
-developers first! You can reach us via
-[github](https://github.com/elasticsearch/logstash-forwarder), the [mailing
-list](http://groups.google.com/group/logstash-users), or via IRC (#logstash on
-freenode irc)
+The process for contributing to any of the Elastic repositories is similar.
 
-## Code and Docs Contribution Steps
+## Contribution Steps
 
-1. Test your changes! Run the test suite ('go test' and 'rspec') 
+1. Test your changes! Run the test suite (`make test`)
 2. Please make sure you have signed our [Contributor License
-   Agreement](http://www.elasticsearch.org/contributor-agreement/). We are not
+   Agreement](https://www.elastic.co/contributor-agreement/). We are not
    asking you to assign copyright to us, but to give us the right to distribute
    your code without restriction. We ask this of all contributors in order to
    assure our users of the origin and continuing existence of the code. You
    only need to sign the CLA once.
 3. Send a pull request! Push your changes to your fork of the repository and
    [submit a pull
    request](https://help.github.com/articles/using-pull-requests). In the pull
-   request, describe what your changes do and mention any open issues related
+   request, describe what your changes do and mention any bugs/issues related
    to the pull request.
 
 
+## Compiling Filebeat
+
+Filebeat is a Go program, so install [golang](http://golang.org/) if you
+don't have it already.
+
+The location where you clone is important. Please clone under the source
+directory of your `GOPATH`. If you don't have `GOPATH` already set, you can
+simply set it to your home directory (`export GOPATH=$HOME`).
+
+    $ mkdir -p $GOPATH/src/github.com/elastic
+    $ cd $GOPATH/src/github.com/elastic
+    $ git clone https://github.com/elastic/filebeat.git
+
+and then compile it with:
+
+    $ cd filebeat
+    $ make
+
+Before you open a pull request, run `make clean` go apply gofmt.

LICENSE

@@ -1,14 +1,13 @@
-Copyright 2012–2015 Jordan Sissel and contributors.
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+    http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-

Makefile

@@ -24,10 +24,20 @@ clean:
 run: build
 	./filebeat -c etc/filebeat.yml -config etc/filebeat.yml -e -v
 
+.PHONY: test
+test:
+	$(GODEP) go test -short ./...
+	make -C tests test
+
 .PHONY: cover
 cover:
 	# gotestcover is needed to fetch coverage for multiple packages
 	go get github.com/pierrre/gotestcover
 	GOPATH=$(shell $(GODEP) path):$(GOPATH) $(GOPATH)/bin/gotestcover -coverprofile=profile.cov -covermode=count github.com/elastic/filebeat/...
 	mkdir -p cover
 	$(GODEP) go tool cover -html=profile.cov -o cover/coverage.html
+
+# Command used by CI Systems
+.PHONE: testsuite
+testsuite: build
+	make cover

README.md

@@ -1,3 +1,34 @@
-# filebeat
+[![Jenkins Build Status](http://build-eu-00.elastic.co/job/filebeat/badge/icon)](http://build-eu-00.elastic.co/job/filebeat/)
+[![Travis Build Status](https://travis-ci.org/elastic/filebeat.svg?branch=master)](https://travis-ci.org/elastic/filebeat)
+[![codecov.io](http://codecov.io/github/elastic/filebeat/coverage.svg?branch=master)](http://codecov.io/github/elastic/filebeat?branch=master)
 
-Beat replacement for logstash-forwarder
+
+# Filebeat
+
+Filebeat is an open source file harvester, mostly used to fetch logs files and feed them into logstash.
+Together with the libbeat lumerjack output is a replacement for [logstash-forwarder](https://github.com/elastic/logstash-forwarder).
+
+
+
+
+## Getting started
+
+Coming ...
+
+## Documentation
+
+Coming ...
+
+## Bugs and feature requests
+
+If you have an issue, please start by opening a topic on the
+[forums](https://discuss.elastic.co/c/beats/filebeat). We'll help you
+troubleshoot and work with you on a solution.
+
+If you are sure you found a bug or have a feature request, open an issue on
+[Github](https://github.com/elastic/filebeat/issues).
+
+## Contributions
+
+We love contributions from our community! Please read the
+[CONTRIBUTING.md](CONTRIBUTING.md) file.