Swift SDK for using IronCore Labs from your iOS mobile applications.
libironoxidevia Homebrew with
brew install IronCoreLabs/ironcore/ironoxide.
File > Swift Packages > Add Package Dependency. Put in the URL for this GitHub repo and select the latest version to use. Then go to your build target
Build Phases > Dependenciesand select
IronOxidefrom the list. Then you'll be able to
import IronOxideinto your XCode project.
Documentation for the latest GitHub tag can be viewed at https://ironcorelabs.github.io/ironoxide-swift/.
The following table shows the compatibility between the version of this Swift library and the required version of the
ironoxide Homebrew library.
Building and testing this library to run on MacOS/Linux varies pretty heavily depending on what architecture you are building for.
cargo build --release. This will generate a bunch of C/C++ header files in a
sdk/generatedfolder as well as generate a library binary in the
libironoxidebinary and headers. This step will go away once we publish
libironoxidefor MacOS on Homebrew and other various Linux package managers (apt, etc).
/usr/local/libdirectory to point to the
ln -s /path/to/ironoxide-swig-bindings/target/release/libironoxide.dylib libironoxide.dylib.
/usr/local/include/directory to point to the C header files directory above:
ln -s /path/to/ironoxide-swig-bindings/cpp/generated/sdk ironoxide.
/usr/lib/pkgconfigon Linux) directory to point to the
.pcfile in the
ln -s /path/to/ironoxide-swig-bindings/cpp/ironoxide.pc.in libironoxide.pc
swift build. If successful this should generate a
.builddirectory. You should also be able to run the tests via
swift testas well (Linux users will need to run
swift test --enable-test-discovery).
Format on Saveoption in VSCode.
sourcekit-lspbinary that came with your Swift installation in your path.
We use jazzy to generate an HTML version of our API docs. Jazzy requires Ruby and can be installed with
[sudo] gem install jazzy.
On a Mac, the docs can be generated simply by running
jazzy --module IronOxide from the root of the repository. This will generate a
docs/ folder that contains the html files. To run jazzy on Linux, additional steps for installing and running can be found here. Documenation for this library is automatically updated via a GitHub action that runs when a new tag is pushed. The docs are hosted via GitHub Pages via the
gh-pages branch of this repo.
Copyright (c) 2021 IronCore Labs, Inc. All rights reserved.