readme, set licence to bsd, same as upstream

This commit is contained in:
patrick-zippenfenig 2022-08-07 14:34:15 +02:00
parent a1358683a8
commit a971801e97
2 changed files with 33 additions and 20 deletions

41
LICENSE
View file

@ -1,21 +1,24 @@
MIT License Copyright (c) 2022, Patrick Zippenfenig (patrick@zippenfenig.de)
All rights reserved.
Copyright (c) 2022 Patrick Zippenfenig Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the author nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
Permission is hereby granted, free of charge, to any person obtaining a copy THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
of this software and associated documentation files (the "Software"), to deal ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
in the Software without restriction, including without limitation the rights WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTOR BE LIABLE FOR ANY
copies of the Software, and to permit persons to whom the Software is DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
furnished to do so, subject to the following conditions: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
The above copyright notice and this permission notice shall be included in all ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
copies or substantial portions of the Software. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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.

View file

@ -2,7 +2,11 @@
[![Test](https://github.com/patrick-zippenfenig/SwiftTimeZoneLookup/actions/workflows/test.yml/badge.svg)](https://github.com/patrick-zippenfenig/SwiftTimeZoneLookup/actions/workflows/test.yml) [![Test](https://github.com/patrick-zippenfenig/SwiftTimeZoneLookup/actions/workflows/test.yml/badge.svg)](https://github.com/patrick-zippenfenig/SwiftTimeZoneLookup/actions/workflows/test.yml)
Resolve geographical coordinates to timezones and countries. This is a Swift wrapper for [ZoneDetect](https://github.com/BertoldVdb/ZoneDetect) Resolve geographical coordinates to timezones and countries. This is a Swift wrapper for [ZoneDetect](https://github.com/BertoldVdb/ZoneDetect).
A timezone database with up to 20 meter resolution is embedded as a bundle resource (~5 MB). If you want to manually specify the database location, use `try SwiftTimeZoneLookup(databasePath: "/path_to_timezone16_21_files/..")`
This library is thread safe.
## Usage ## Usage
Add `SwiftTimeZoneLookup` as a dependency to your `Package.swift` Add `SwiftTimeZoneLookup` as a dependency to your `Package.swift`
@ -19,6 +23,7 @@ Add `SwiftTimeZoneLookup` as a dependency to your `Package.swift`
``` ```
In your code In your code
```swift ```swift
import SwiftTimeZoneLookup import SwiftTimeZoneLookup
@ -53,3 +58,8 @@ LIBRARY_PATH=/opt/homebrew/Cellar/shapelib/1.5.0/lib CPATH=/opt/homebrew/Cellar/
cp out_v1/timezone* ../../../../Sources/SwiftTimeZoneLookup/Resources cp out_v1/timezone* ../../../../Sources/SwiftTimeZoneLookup/Resources
``` ```
## Credits
[ZoneDetect](https://github.com/BertoldVdb/ZoneDetect) as the upstream library.
Contains data from Natural Earth, placed in the Public Domain. Contains information from https://github.com/evansiroky/timezone-boundary-builder, which is made available here under the Open Database License (ODbL)