From a57c43a7e4c523fb70b5301270c4888173a33f37 Mon Sep 17 00:00:00 2001 From: Tom Hicks Date: Thu, 15 Apr 2021 21:45:52 -0700 Subject: [PATCH] Updates docs and readme to include a description of the app features. --- iOS/README.md | 20 ++++++++++++++++++++ iOS/docs/Gemfile | 2 ++ iOS/docs/Gemfile.lock | 4 +++- iOS/docs/index.markdown | 21 +++++++++++++++++++++ 4 files changed, 46 insertions(+), 1 deletion(-) diff --git a/iOS/README.md b/iOS/README.md index e2ee4e1..cc9da98 100644 --- a/iOS/README.md +++ b/iOS/README.md @@ -1,2 +1,22 @@ +# MonsterCards + [![Build status](https://build.appcenter.ms/v0.1/apps/bbde5430-0b21-4b78-aa2f-32ce210fc578/branches/master/badge)](https://appcenter.ms) +MonsterCards let you create and store monster statblocks for 5e compatible sytems. You can also import the files created by the popular 5e stat block generator at [https://tetra-cube.com/dnd/dnd-statblock.html] You monster library is synced between your devices using iCloud. You'll need to create your own app ids, provisioning profiles, and iCloud storage if building from source. Due to the way iCloud works. Building from source will mean you sync data to a different iCloud container than using the official app. The app is currently in limited beta but will be available in the app store as soon as the collection and dashboard features are finished. + +## Coming Soon + +These are things we intend to complete before launching v1.0 + +* Collections - You will be able to group your saved monsters in collections. This is useful for grouping monsters by session/location/campaign. +* Dashboard - A set of monster thumbnails with vital stats that you can open to view full monster cards. This is useful for running encounters or having all the monsters you need for a session handy +* Native export/import format - We will be adding a file format for sharing monsters with other users so you can easily share creations to other users. + +## Wishlist + +These may never happen. + +* [Android version](https://github.com/headhunter45/MonsterCards-Android) +* Other import formats - We're taking suggestions +* Initiative Tracker - A basic initiative/hit point tracker. +* NFC - Put an NFC sticker on a mini and scan the mini to show it's card. diff --git a/iOS/docs/Gemfile b/iOS/docs/Gemfile index 6fbe54e..a1bbc53 100644 --- a/iOS/docs/Gemfile +++ b/iOS/docs/Gemfile @@ -29,3 +29,5 @@ end # Performance-booster for watching directories on Windows gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + +gem "webrick", "~> 1.7" diff --git a/iOS/docs/Gemfile.lock b/iOS/docs/Gemfile.lock index 2e6449b..dd81607 100644 --- a/iOS/docs/Gemfile.lock +++ b/iOS/docs/Gemfile.lock @@ -253,6 +253,7 @@ GEM unf_ext unf_ext (0.0.7.7) unicode-display_width (1.7.0) + webrick (1.7.0) zeitwerk (2.4.2) PLATFORMS @@ -265,6 +266,7 @@ DEPENDENCIES tzinfo (~> 1.2) tzinfo-data wdm (~> 0.1.1) + webrick (~> 1.7) BUNDLED WITH - 2.2.15 + 2.2.16 diff --git a/iOS/docs/index.markdown b/iOS/docs/index.markdown index ed7f736..0a566b9 100644 --- a/iOS/docs/index.markdown +++ b/iOS/docs/index.markdown @@ -4,3 +4,24 @@ # layout: home --- + +[![Build status](https://build.appcenter.ms/v0.1/apps/bbde5430-0b21-4b78-aa2f-32ce210fc578/branches/master/badge)](https://appcenter.ms) + +MonsterCards let you create and store monster statblocks for 5e compatible sytems. You can also import the files created by the popular 5e stat block generator at [https://tetra-cube.com/dnd/dnd-statblock.html](https://tetra-cube.com/dnd/dnd-statblock.html) You monster library is synced between your devices using iCloud. You'll need to create your own app ids, provisioning profiles, and iCloud storage if building from source. Due to the way iCloud works. Building from source will mean you sync data to a different iCloud container than using the official app. The app is currently in limited beta but will be available in the app store as soon as the collection and dashboard features are finished. + +## Coming Soon + +These are things we intend to complete before launching v1.0 + +* Collections - You will be able to group your saved monsters in collections. This is useful for grouping monsters by session/location/campaign. +* Dashboard - A set of monster thumbnails with vital stats that you can open to view full monster cards. This is useful for running encounters or having all the monsters you need for a session handy +* Native export/import format - We will be adding a file format for sharing monsters with other users so you can easily share creations to other users. +* [Android version](https://github.com/headhunter45/MonsterCards-Android) + +## Wishlist + +These may never happen. + +* Other import formats - We're taking suggestions +* Initiative Tracker - A basic initiative/hit point tracker. +* NFC - Put an NFC sticker on a mini and scan the mini to show it's card.