diff --git a/README.md b/README.md index d40c9a2..394d6c1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This is an API to work with the LunaNode's OpenStack-compatible [citation needed ## API Keys -Add the `LUNANODE_API_KEY` and `LUNANODE_KEY_ID` to your environment variables. +Add the `LUNANODE_API_KEY`, `LUNANODE_KEY_ID` and `LUNANODE_API_PARTIALKEY` (the first 64 chars of `LUNANODE_API_KEY`) to your environment variables. ## Usage @@ -33,9 +33,10 @@ See section help for more details, i.e.: `lunanode image help` ## TODO (looking for contributors) -* [ ] Simplify code so there is less boilerplate. In particular, writing out every enum variant is pretty annoying when I need the same info out of them either way. +* [ ] Create more detailed documentation. `#[deny(missing_docs)]` is on, but some of the decisions in the code aren't explained very well. * [ ] Tests!!! I've written some, but this should be comprehensively tested. * [ ] Write tests that involve talking with a live server! This will enable breaking changes from LunaNode to be seen before they are messed with. + * [ ] Write a local test server for faster, more easily created edge-case testing. * [ ] Stricter typing. Certain attributes, even though they are recieved as Strings, should really be some kind of `enum`. Make every non-String type some kind of enum. * [ ] UUIDs should be UUID types and not string. The only library I could find to do this, Uuid, seems to serialize them without the dashes, which screws up Lunanode... annoyingly. * [ ] Subnets should be more strictly types. They should always be an IP/subnet combo as two fields (std::net::Ipv4Addr, i32(0..32)).