Merge pull request #9 from UMD-ARLIS/master
[incubator-flagon-distill.git] / README.rst
index b78a2fcdf998c50fa2170be3e16b3ccc43e58b23..ad8f0b3b813fdd1500573d0ac32558ab7fd2f826 100644 (file)
@@ -1,41 +1,33 @@
-==================================================================
-distill: An analytical framework for User-ALE <https://github.com/draperlaboratory/user-ale>.
-==================================================================
+.. ..
 
 
-Installation
-------------
+       <!---
+    Copyright 2022 The Applied Research Laboratory for Intelligence and Security (ARLIS)
 
 
-The easiest way to install most Python packages is via ``easy_install`` or ``pip``::
+    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
 
 
-    $ easy_install distill
+         http://www.apache.org/licenses/LICENSE-2.0
 
 
-Development and Testing
-------------
+       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. 
+       --->
 
 
-To build the source code and run all unit tests::
+.. image:: https://readthedocs.org/projects/incubator-flagon-distill/badge/?version=distill_toolkit_refactor
+       :target: https://incubator-flagon-distill.readthedocs.io/en/distill_toolkit_refactor/?badge=stable
+       :alt: Documentation Status
 
 
-    $ python setup.py develop test
+Apache Flagon Distill
+=======================
 
 
-To start up the web server, running on localhost:8090::
+This project is under transition to the Apache Software Foundation.
 
 
-    $ dev
+Please see our `readthedocs.org pages <https://incubator-flagon-distill.readthedocs.io/en/distill_toolkit_refactor/>`_ for documentation.
 
 
-Using  ``curl``::
-
-       $ curl -XGET '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/>`_.