EOSIO / eosio-swift-vault

Utility library for managing keys and signing with Apple's Keychain and Secure Enclave
https://eosio.github.io/eosio-swift-vault/
MIT License
12 stars 8 forks source link

WIP: Add README and CONTRIBUTING #12

Closed brandonfancher closed 5 years ago

brandonfancher commented 5 years ago

For README documentation, I decided to commit the jazzy docs and refer devs to that. This is a lower-level lib and there are many methods a dev might want to use.

When we release, we'll switch to referring to the doc gen tool of dev relations' choice.

brandonfancher commented 5 years ago

Good catch. Should be fixed now.

brandonfancher commented 5 years ago

Some links in README that is rendered in index.html don't work. But I'm not worried about those right now. Dev relations may end up wanting a different tool and/or approach to documentation anyway.