From 016f273f575f99f8ade9fefc45a7895b565823ca Mon Sep 17 00:00:00 2001 From: Chris Gansen Date: Tue, 9 Apr 2013 23:30:23 -0500 Subject: [PATCH] update readme and add license --- LICENSE.md | 7 +++++++ README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++-- README.rdoc | 28 ---------------------------- 3 files changed, 53 insertions(+), 30 deletions(-) create mode 100644 LICENSE.md delete mode 100644 README.rdoc diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..18501437d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright (c) 2013 Chris Gansen, Smart Chicago Collaborative + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index f3b1542df..f7c948dff 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,46 @@ -logan -===== \ No newline at end of file +Logan +===== + +Logan is an application to manage people that are involved with the Smart Chicago CUT Group. + +Features +-------- + +Logan is a customer relationship management application at its heart. Logan tracks people that have signed up to participate with the CUT Group, their involvement in events and CUT Group programs. + +TODO +---- + +* External integrations + * Export list segment to mailchimp +* Events + * CRUD + * Invite + * RSVP + * Attendance tracking + * Reminder emails +* Programs + * CRUD + * Associate results +* People + * Add arbitrary fields + * Add notes + * Attach photograph + * Attach files +* Backend + * User accounts + * Terms of service/privacy policy + * Managed access to anonymized data for research + * Audit trails + * Comments on all objects + +Contributors +------------ + +* Chris Gansen (cgansen@gmail.com) +* Dan O'Neil (doneil@cct.org) + +License +------- + +The application code is released under the MIT License. See [LICENSE](LICENSE.md) for terms. \ No newline at end of file diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e22..000000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app.