fixes typo in asf.yaml file
[incubator-flagon-distill.git] / README.rst
index 2ae6ceee61762425b6e9534fb4050788926412e6..ca0929ea20a2e2b69ce889c7d69661313b890c5f 100644 (file)
@@ -1,45 +1,30 @@
-==================================================================
-distill: An analytical framework for User-ALE <https://github.com/draperlaboratory/user-ale>.
-==================================================================
+.. ..
 
-TODO: Modify the whole file as necessary.
+       <!--- Licensed to the Apache Software Foundation (ASF) under one or more
+       contributor license agreements.  See the NOTICE file distributed with
+       this work for additional information regarding copyright ownership.
+       The ASF licenses this file to You 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
 
-This is a "long description" file for the package that you are creating.
-If you submit your package to PyPi, this text will be presented on the `public page <http://pypi.python.org/pypi/python_package_boilerplate>`_ of your package.
+         http://www.apache.org/licenses/LICENSE-2.0
 
-Note: This README has to be written using `reStructured Text <http://docutils.sourceforge.net/rst.html>`_, otherwise PyPi won't format it properly.
+       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. 
+       --->
 
-Installation
-------------
+Apache Flagon Distill
+=======================
 
-The easiest way to install most Python packages is via ``easy_install`` or ``pip``::
+NOTE: This project is not currently maintained and will be refactored. If you are interested in Distill, join the discussion on our dev list: dev-subscribe@flagon.incubator.apache.org.
 
-    $ easy_install distill
+Distill is part of the `Apache Flagon <http://flagon.incubator.apache.org/>`_ project.
+It comprises an analytical engine for `UserALE <http://flagon.incubator.apache.org/userale/>`_
+to interact with user activity logs and apply basic analytical operations to the data.
 
-Development and Testing
-------------
-To build the source code and run all unit tests
+Install instructions can be found `here <http://flagon.incubator.apache.org/docs/distill/>`_.
 
-       $ python setup.py develop test
-
-To start up the web server, running on localhost:8090
-       $ dev
-
-Using curl
-       $ curl http://localhost:8090/app/register' -d '{
-               "application_name" : "my_app",
-               "version" : "0.1",
-               "application_description" : "my test app"
-       }'
-
-Usage
------
-
-TODO: This is a good place to start with a couple of concrete examples of how the package should be used.
-
-The boilerplate code provides a dummy ``main`` function that prints out the word 'Hello'::
-
-    >> from distill import main
-    >> main()
-    
-When the package is installed via ``easy_install`` or ``pip`` this function will be bound to the ``distill`` executable in the Python installation's ``bin`` directory (on Windows - the ``Scripts`` directory).
+A contribution guide has been provided `here <http://flagon.incubator.apache.org/docs/contributing/>`_.
\ No newline at end of file