fix: quick typos and screenshot crates.io fix (#28)

storopoli · Mar 23, 2024 · e0440ed · e0440ed
1 parent 9b5b538
commit e0440ed
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,13 @@
 
 [![AGPL-v3](https://img.shields.io/badge/License-AGPL&nbsp;v3-lightgrey.svg)](https://opensource.org/license/agpl-v3/)
 
-![screnshot](screenshot.png)
+This is a simple implementation of a
+[Dead Man's Switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch).
+
+Use at your own risk.
+Check the f****(as in friendly) code.
+
+![screenshot](https://github.com/storopoli/dead-man-switch/blob/main/screenshot.png)
 
 Dead man's switches are designed to require positive action
 or they will automatically deploy.

diff --git a/src/main.rs b/src/main.rs
@@ -1,10 +1,10 @@
 //! # Dead Man's Switch
 //!
 //! This is a simple implementation of a
-//! [Dead Man's Switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch)
+//! [Dead Man's Switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch).
 //!
 //! Use at your own risk.
-//! Check the f*(as in friendly) code.
+//! Check the f****(as in friendly) code.
 
 use anyhow::Result;
 

diff --git a/src/timer.rs b/src/timer.rs
@@ -1,4 +1,4 @@
-//! This module contains the timer implementations
+//! Timer implementations
 //!
 //! Timers are created using the [`Timer`] struct.
 //!

diff --git a/src/tui.rs b/src/tui.rs
@@ -1,4 +1,4 @@
-//! This module contains the TUI implementation for the Dead Man's Switch.
+//! TUI implementation for the Dead Man's Switch.
 
 use std::io;
 use std::time::Duration;