diff --git a/README.md b/README.md new file mode 100644 index 0000000..fadc43a --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# ical2csv + +![alt text](images/ics.png) → ![alt text](images/python.png) → ![alt text](images/csv.png) + +A command line Python script that will read an ics file and write it's contents to a csv file. + +## Installation +Download the `ical2csv.py` file. + +### Dependencies: +* ***icalendar*** + * [**Homepage**](http://icalendar.readthedocs.org/) + * [**Code**](http://github.com/collective/icalendar) + * **Installation**: `pip install icalendar` +* ***Python* 2** + +## Usage + +Call the script and pass in the location of the ics file. + +Ex: `python ical2csv event.ics` + +## Contributing + +1. Fork it! +2. Create your feature branch: git checkout -b my-new-feature +3. Commit your changes: git commit -am 'Add some feature' +4. Push to the branch: git push origin my-new-feature +5. Submit a pull request 😊 + +## Credits + +Lead Developer - [Erik Cox](@erikcox) + +## License + +The MIT License (MIT) + +Copyright (c) 2016 Erik Cox + +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/images/csv.png b/images/csv.png new file mode 100644 index 0000000..640601b Binary files /dev/null and b/images/csv.png differ diff --git a/images/ics.png b/images/ics.png new file mode 100644 index 0000000..bc4d8eb Binary files /dev/null and b/images/ics.png differ diff --git a/images/python.png b/images/python.png new file mode 100644 index 0000000..a7584a2 Binary files /dev/null and b/images/python.png differ