Updated Documentation, Bumped to Bevy 0.15

Cargo.toml

@@ -18,8 +18,8 @@ lazy_static = "1.5"
 git = "https://git.exvacuum.dev/bevy_basic_interaction"
 tag = "v0.2.0"
 
-[depedencies.yarnspinner]
-git = "https://github.com/YarnSpinnerTool/YarnSpinner-Rust
+[dependencies.yarnspinner]
+git = "https://github.com/YarnSpinnerTool/YarnSpinner-Rust"
 
 [dependencies.bevy]
 version = "0.15"

README.md

@@ -6,15 +6,16 @@
 
 | Crate Version | Bevy Version |
 |---            |---           |
+| 0.2           | 0.15         |
 | 0.1           | 0.14         |
 
 ## Installation
 
-If enough people (like literally 1 person) want this on crates.io I'll consider putting it up there, but for now just add the GitHub URL to your `Cargo.toml`:
+If enough people (like literally 1 person) want this on crates.io I'll consider putting it up there, but for now just add the Git URL to your `Cargo.toml`:
 
 ```toml
 [dependencies.bevy_terminal_dialog]
-git = "https://github.com/exvacuum/bevy_terminal_dialog"
+git = "https://git.exvacuum.dev/bevy_terminal_dialog"
 ```
 
 ## License

src/widgets.rs

@@ -41,6 +41,7 @@ pub struct DialogBoxWidget {
 }
 
 impl DialogBoxWidget {
+    /// Constructs a new dialog box widget
     pub fn new(character: Option<String>, text: Vec<(String, Style)>, speed: Duration) -> Self {
         Self {
             character,
@@ -54,10 +55,12 @@ impl DialogBoxWidget {
         }
     }
 
+    /// Sets the character speaking, or title of the dialog
     pub fn set_character(&mut self, character: Option<String>) {
         self.character = character
     }
 
+    /// Sets the text contained inside the dialog box
     pub fn set_text(&mut self, text: Vec<(String, Style)>) {
         self.character_count = text.iter().fold(0, |count, (string, _)| count + string.graphemes(true).count());
         self.text = text;
@@ -65,10 +68,12 @@ impl DialogBoxWidget {
         self.last_character = Instant::now();
     }
 
+    /// Gets whether all of this dialog box's text has been displayed yet
     pub fn typewriter_complete(&self) -> bool {
         self.character_count == 0 || self.typewriter_index >= self.character_count
     }
 
+    /// Skips the typewriter effect, displaying all text in the dialog box
     pub fn skip_typewriter(&mut self) {
         self.typewriter_index = self.character_count;
     }