diff --git a/.gitignore b/.gitignore index 65ed242..4e7995f 100644 --- a/.gitignore +++ b/.gitignore @@ -5,5 +5,5 @@ # Sass stuff .sass-cache/ -# Lists -lists/*.list +# Notes +notes/*.note diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a96e9d..adbd6a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Version 1.0.1 (3 Jan 2018) -Add a More/Less button for uncollapsing/collapsing long lists that +Add a More/Less button for uncollapsing/collapsing long notes that have been cut using a horizontal rule. # Version 1.0.0 (2 Jan 2018) diff --git a/README.md b/README.md index 92daa4c..ffd5072 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A [Rocket](https://rocket.rs) based web application written in Rust for maintaining a pinboard of notes for a family or group of friends. Similarly to a Wiki, all notes can be edited by everyone, as a board with -physical lists would also allow. +physical notes would also allow. ## Building @@ -21,17 +21,17 @@ $ scss static/scss/pinboard.scss:static/csss/pinboard.css ## Usage -The lists are stored as plain text files (in Markdown format) under the -`lists` subdirectory. As an administrator of the application, you should -touch a file with the extension `.list` in this subdirectory to create -lists. The resulting list names are the title cased version of the snake -cased filenames. For example to create a list for "John Doe": +The notes are stored as plain text files (in Markdown format) under the +`notes` subdirectory. As an administrator of the application, you should +touch a file with the extension `.note` in this subdirectory to create +notes. The resulting note names are the title cased version of the snake +cased filenames. For example to create a note for "John Doe": ``` -$ touch lists/john_doe.list +$ touch notes/john_doe.note ``` -After creating new lists, start (or restart) the application and then visit: +After creating new notes, start (or restart) the application and then visit: http://localhost:8000/. For setting up production or staging environments, see the @@ -44,10 +44,10 @@ There are still quite some things left to do. Here are some points of improvement for the future: * Use a Rust-implementation for Sass -* Support different sets of lists (for different environments) +* Support different sets of notes (for different environments) * Get rid of hardcoded strings in the UI (for example the name of my family) * Add i18n to support several languages -* Support locking a list while editing it in the client so other clients +* Support locking a note while editing it in the client so other clients cannot edit it ## License diff --git a/src/handlers/note.rs b/src/handlers/note.rs index 42edb2d..ce73435 100644 --- a/src/handlers/note.rs +++ b/src/handlers/note.rs @@ -54,7 +54,7 @@ mod tests { assert_eq!(notes[0].name, "Test"); assert_eq!( notes[0].data, - "This is a test list\n\n* One\n* Two\n* Three\n" + "This is a test note\n\n* One\n* Two\n* Three\n" ); // The mtime field can vary, don't test for it // The path field is private, also don't test for it @@ -75,7 +75,7 @@ mod tests { let body = res.body_string().unwrap(); assert_eq!( body, - r#"

This is a test list

+ r#"

This is a test note