readme, license

README.md

@@ -0,0 +1,59 @@
+# Session Title Suggestions for FoundryVTT
+
+## Overview
+
+This FoundryVTT module allows players to suggest titles for the session, similar to how podcast titles are suggested. In my own sessions, I record every session's audio and make it into a podcast. Many of my favorite podcasts use a random, funny, out-of-context quote from the episode for the title. Inspired by this, I created this module so players can suggest titles and the GM can list them all and choose the best one. Players can use the `/title` or `/t` command to suggest a title. A GM or trusted player can use the `/titles` or `/ts` command to get a list of all the suggestions for the most recent day's session.
+
+## Features
+
+- Players can suggest session titles using the `/title`, `/t`, or `t/` command.
+- GMs or trusted players can view all suggested titles for the most recent session using the `/titles` or `/ts` command.
+
+## Requirements
+
+This module requires the Chat Commander module to be installed and enabled. You can find it [here](https://gitlab.com/woodentavern/foundryvtt-chat-command-lib).
+
+## Installation
+
+1. Open FoundryVTT and go to the "Add-on Modules" tab in the "Configuration and Setup" menu.
+2. Click on "Install Module".
+3. In the "Manifest URL" field, paste the following URL: `[your-module-manifest-url]`.
+4. Click "Install" and wait for the installation to complete.
+5. Enable the module in your game settings.
+
+## Usage
+
+### Suggesting a Title
+
+Players can suggest a title for the current session by typing one of the following commands in the chat:
+
+`/title [Your Suggested Title]`
+`/t [Your Suggested Title]`
+
+Example:
+`/title The Great Heist`
+
+### Viewing Suggested Titles
+
+GMs or trusted players can view all the suggested titles for the most recent session by typing one of the following commands in the chat:
+
+`/titles`
+`/ts`
+
+This will display a list of all the title suggestions.
+
+## Contributing
+
+If you want to contribute to the development of this module, feel free to fork the repository and submit a pull request. Any contributions, such as bug fixes, feature requests, or enhancements, are welcome.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE.TXT) file for details.
+
+## Contact
+
+For any questions or issues, please open an issue on this GitHub repository.
+
+---
+
+Thank you for using the FoundryVTT Session Title Suggestions Module! Happy gaming!