Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Update readme, images and version
  • Loading branch information
Conhan93 committed Sep 5, 2022
1 parent a1c18c8 commit a686956
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 6 deletions.
Binary file modified Images/LookupDisplay.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/LookupSpellPop.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/LookupStart.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ Desktop app that lets you search for monsters from Dungeons and Dragons and easi
For your DM:ing needs. Currently only supports monsters and spells that pops up when you select an ability containing spells.

The app UI is built with [Compose Multiplatform](https://www.jetbrains.com/lp/compose-mpp/) and supports both dark and light themes.
Uses an embedded H2 database for local storage to cache recently fetched monsters and spells.
Uses an embedded database for local storage to cache recently fetched monsters and spells.

The information is fetched from an open Dungeons and Dragons [API](https://www.dnd5eapi.co/)
that lets you fetch information from monsters, items, spells, etc in JSON format.
that lets you fetch information from monsters, items, spells, etc.


## Images
<figure>
Expand All @@ -36,11 +37,11 @@ that lets you fetch information from monsters, items, spells, etc in JSON format

## Planned

- Fetch information for spells and other abilities that come packed in other actions/abilities and display them

- Add a loading animation when searching
- Add proper fonts
- Make better use of themes by moving shapes and typography into it
- UI Tests
- ~~UI Tests~~ When UI tests are more developed for compose desktop


[compose_url]: https://github.com/JetBrains/compose-jb/releases/tag/v1.2.0-alpha01-dev774
Expand Down
6 changes: 4 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ plugins {
kotlin("plugin.serialization") version "1.6.10"
}

val appVersion : String by project

group = "me.conha"
version = "1.0"
version = version

val exposedVersion : String by project
val h2Version : String by project
Expand Down Expand Up @@ -65,7 +67,7 @@ compose.desktop {

// Distributable info
packageName = "Monster Lookup"
packageVersion = "1.0.0"
packageVersion = appVersion
description = "App for all your DnD monster look up needs!"


Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
kotlin.code.style=official
exposedVersion=0.39.2
h2Version=2.1.214
appVersion=1.2.0

0 comments on commit a686956

Please sign in to comment.