Skip to content

Commit

Permalink
Readme badges + cleanup package
Browse files Browse the repository at this point in the history
  • Loading branch information
Konstantinos Gaitanis committed Aug 21, 2024
1 parent 3e6c944 commit 2ec777f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
5 changes: 2 additions & 3 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ let package = Package(
name: "IcpKit",
platforms: [
.iOS(.v16),
.macOS(.v13)
.macOS(.v11),
.macCatalyst(.v16),
],
products: [
// Products define the executables and libraries a package produces, making them visible to other packages.
Expand All @@ -22,7 +23,6 @@ let package = Package(
.package(url: "https://github.com/outfoxx/PotentCodables.git", .upToNextMajor(from: "3.2.0")),
.package(url: "https://github.com/immobiliare/RealHTTP.git", .upToNextMajor(from: "1.8.3")),
.package(url: "https://github.com/swift-libp2p/swift-bases.git", .upToNextMajor(from: "0.0.1")),
.package(url: "https://github.com/GigaBitcoin/secp256k1.swift.git", exact: "0.10.0"),
.package(url: "https://github.com/horizontalsystems/HsCryptoKit.Swift.git", .upToNextMajor(from: "1.2.1")),
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
],
Expand All @@ -35,7 +35,6 @@ let package = Package(
"Candid",
"BigInt",
"RealHTTP",
.product(name: "secp256k1", package: "secp256k1.swift"),
.product(name: "HsCryptoKit", package: "HsCryptoKit.Swift"),
// .target(name: "bls12381"),
]
Expand Down
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
![IcpKit](IcpKit.png)

# IcpKit
![IcpKit](IcpKit.png)
[![Build Status][build status badge]][build status] [![Code Coverage][codecov badge]][codecov]
[![Platforms][platforms badge]][swift package] [![][swift versions]][swift package]
[![License: MIT][license]][license badge]

A comprehensive iOS package for writing mobile applications that interact with the Internet Computer Protocol (ICP), written in Swift.
IcpKit aims at facilitating the interaction between iOS apps and the ICP blockchain.

For more information about ICP Development, we recommend starting from https://internetcomputer.org/docs/current/references/

[![codecov](https://codecov.io/gh/kosta-bity/IcpKit/graph/badge.svg?token=QL11UD2IXD)](https://codecov.io/gh/kosta-bity/IcpKit)

## Contributors
The main developer of this package is Konstantinos Gaitanis.
The main developer of this package is [Konstantinos Gaitanis](https://github.com/kgaitanis).

This Package has been built by [Bity SA](https://bity.com) with the help of the [DFinity Foundation Developer Grant Program](https://dfinity.org/grants).

Expand All @@ -21,9 +21,6 @@ The BLS12381 Rust Library is licensed by Levi Feldman (see [LICENSE](Sources/bls

## Installation

min iOS version : v16
min macOs version: v13

### Swift Package Manager
Adding IcpKit as a dependency to your Xcode project is as easy as adding it to the `dependencies` value of your `Package.swift`.

Expand Down Expand Up @@ -457,3 +454,14 @@ class SimpleSigningPrincipal: ICPSigningPrincipal {
- Encoding of `CandidFunctionProtocol` is not supported as there is no easy way to infer the `CandidTypes` used in the arguments and results of the function. This means that the automatic code generation will fail when calling a canister method that expects another function as input.
- Encoding of `CandidServiceProtocol` is not supported because functions can not be encoded.
- Encoding of optional `Structs` can not infer the members of the struct. These are encoded as `opt empty` which should be accepted by all canisters according to Candid specifications.


[build status]: https://github.com/kosta-bity/IcpKit/actions
[build status badge]: https://github.com/kosta-bity/IcpKit/actions/workflows/IcpKit-Tests.yml/badge.svg
[swift package]: https://swiftpackageindex.com/kosta-bity/IcpKit
[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fkosta-bity%2FIcpKit%2Fbadge%3Ftype%3Dplatforms
[codecov badge]: https://codecov.io/gh/kosta-bity/IcpKit/graph/badge.svg?token=QL11UD2IXD
[codecov]: https://codecov.io/gh/kosta-bity/IcpKit
[license]: https://img.shields.io/badge/License-MIT-yellow.svg
[license badge]: https://opensource.org/licenses/MIT
[swift versions]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fkosta-bity%2FIcpKit%2Fbadge%3Ftype%3Dswift-versions

0 comments on commit 2ec777f

Please sign in to comment.