Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Officially open-sourced, and added some more documentation.

  • Loading branch information...
commit 9d1f216762d3c648659d7dcffd34ffec41fa3c99 1 parent bc0118b
@grigorescu authored
Showing with 28 additions and 5 deletions.
  1. +14 −0 COPYING
  2. +14 −5 README.md
View
14 COPYING
@@ -0,0 +1,14 @@
+Copyright (c) 2012, Vlad Grigorescu
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
19 README.md
@@ -3,6 +3,20 @@ Brownian
Brownian is a web interface for viewing and interacting with [Bro IDS](http://bro-ids.org/) logs.
+Why Brownian?
+-------------
+
+Brownian motion relates to the elastic collisions and random motion of particles. Brownian aims to help you leverage Bro and ElasticSearch to make sense of a massive amount of seemingly random data.
+
+TODO
+----
+
+A lot. This is very much a work in progress. Many features aren't working yet - I've tried to document them with either a TODO comment or an Issue on GitHub (or both).
+
+If you see something that's broken, or something that you'd like added, please create an issue.
+
+As always, fork, patch, and push away!
+
Prerequisites
-------------
@@ -52,8 +66,3 @@ Running Development Server
$ export DJANGO_SETTINGS_MODULE=Brownian.settings
$ python ./Brownian/bin/django-admin.py runserver
```
-
-TODO
-----
-
-Please see the issues section.
Please sign in to comment.
Something went wrong with that request. Please try again.