Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
fgulan committed Nov 10, 2023
1 parent 9ba086e commit 96ceb1a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,24 @@
[![Swift Package Manager](https://img.shields.io/badge/swift%20package%20manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)
![Platforms](https://img.shields.io/static/v1?label=platform&message=iOS%2013%20&color=brightgreen)

## Example
<p align="center">
<img src="img/halley-logo.png" width="300" max-width="50%" alt="Halley"/>
</p>

To run the example project, clone the repo, and run `pod install` from the Example directory first.
Halley provides a simple way on iOS to parse and traverse models according to [JSON Hypertext Application Language specification](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal) also known just as HAL.

## Requirements
## Getting started

### Requirements

- iOS 13
- Swift 5.0

## Installation
There are several ways to include _Halley_ in your project, depending on your use case.

### CocoaPods

Halley is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
Halley is available through [CocoaPods](https://cocoapods.org). To install it, simply add the following line to your Podfile:

```ruby
pod 'Halley'
Expand All @@ -36,8 +39,19 @@ dependencies: [

## Author

Filip Gulan, [email protected]
Zoran Turk, [email protected]
* Filip Gulan - [email protected]
* Zoran Turk - [email protected]

Maintained and sponsored by [Infinum](http://www.infinum.com).

<p align="center">
<a href='https://infinum.com'>
<picture>
<source srcset="https://assets.infinum.com/brand/logo/static/white.svg" media="(prefers-color-scheme: dark)">
<img src="https://assets.infinum.com/brand/logo/static/default.svg">
</picture>
</a>
</p>

## License

Expand Down
Binary file added img/halley-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 96ceb1a

Please sign in to comment.