Initial set-up and establishment of a structure for the project
This commit is contained in:
@@ -1,3 +1,6 @@
|
|||||||
|
# Custom additions
|
||||||
|
logs/
|
||||||
|
|
||||||
# Byte-compiled / optimized / DLL files
|
# Byte-compiled / optimized / DLL files
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2024 Lars Winzer
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# POST-IT!
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The **Cross-Platform Post Embedder Bot** is a Discord bot designed to unify and simplify the process of sharing media from multiple platforms such as Reddit, Twitter, Tumblr, Mastodon, and more
|
||||||
|
|
||||||
|
## Planned Platforms
|
||||||
|
|
||||||
|
- Reddit
|
||||||
|
- X (f.k.a. Twitter)
|
||||||
|
- Tumblr
|
||||||
|
- Mastodon
|
||||||
|
- Other social media platforms to be added in future releases
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. **Post Link Submission:** Users provide a link to a post from a supported platform.
|
||||||
|
2. **Embed Generation:** The bot fetches the content of the post (e.g. images, text) and generates a standardized Discord embed.
|
||||||
|
3. **Customization:** Depending on user or server settings, the format of the embed can vary, allowing for a personalized experience.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
|
||||||
|
|
||||||
|
Feel free to adjust or add any specific details related to the functionality of your bot or any additional features as they are implemented!
|
||||||
Reference in New Issue
Block a user