Skip to content

Commit

Permalink
Add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
richardtop committed May 9, 2021
1 parent cb19388 commit b578736
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT license

Copyright (c) 2021 Richard Topchii

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.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
![CalendarApp](https://user-images.githubusercontent.com/8013017/117589582-193feb80-b133-11eb-80ed-1b72b69f7006.png)

[![License](https://img.shields.io/github/license/richardtop/calendarkit)](https://swiftpackageindex.com/richardtop/CalendarKit)

# CalendarApp

**CalendarApp** is a tempalte repository serving as a starting point for experiments with [CalendarKit](https://github.com/richardtop/CalendarKit). It's a sample calendar app for iOS built with [CalendarKit](https://github.com/richardtop/CalendarKit) and [EventKit](https://developer.apple.com/documentation/eventkit). It displays events stored in the `EKEventStore` similarly to the default calendar app.

## Getting Started
To run the app, just clone the repository and open `Calendar.xcodeproj`. If you'd like to edit the code, press "Use this template" to copy this repository to your GitHub account and keep your changes.

## Need Help?
If you have a **programming question** about how to use CalendarKit in your application, ask it on StackOverflow with the [CalendarKit](https://stackoverflow.com/questions/tagged/calendarkit) tag.

Please, use [GitHub Issues](https://github.com/richardtop/CalendarKit/issues) only for reporting a bug or requesting a new feature.


## Examples
[Video](https://youtu.be/KR58xW0TkwI)

[Try live in a browser](https://appetize.io/app/k85kqpdr1fp79e59f1c4ar8cx4)

To try CalendarKit with CocoaPods issue the following command in the Terminal:
```ruby
pod try CalendarKit
```

## Requirements

To run CalendarApp:

- Xcode 12
- iOS 14


## Author

Richard Topchii


## License

**CalendarApp** is available under the MIT license. See the LICENSE file for more info.

0 comments on commit b578736

Please sign in to comment.