diff --git a/README.md b/README.md index 4d51920..2c50678 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,93 @@ -# Bluesky Connector Plugin for WordPress +# Bluesky Publisher for WordPress + +Automatically share your WordPress posts to Bluesky with customizable formatting, image handling, and queue management. ## Description -This plugin connects your WordPress blog to Bluesky and allows you to format and publish posts to Bluesky whenever a new post is published. Users can log into their Bluesky account via the plugin, and the plugin will automatically generate and store the API key. + +Bluesky Publisher for WordPress enables automatic cross-posting of your WordPress content to Bluesky. With customizable post formatting, image support, and reliable queue management, you can ensure your content looks great on Bluesky. + +### Features + +* Automatic post sharing to Bluesky +* Customizable post formatting +* Featured image support with automatic resizing +* Queue management for reliable posting +* Post meta box for post status and manual controls +* Support for post titles, excerpts, and links +* Proper spacing and formatting of posts +* Automatic token refresh + +## Requirements + +- WordPress 5.0 or higher +- PHP 7.4 or higher +- Bluesky account ## Installation -1. Upload the `bluesky-connector` folder to the `/wp-content/plugins/` directory. -2. Activate the plugin through the 'Plugins' menu in WordPress. -3. Configure the plugin settings in the WordPress admin under 'Settings' > 'Bluesky Connector'. + +1. Upload 'bluesky-connector' folder to the '/wp-content/plugins/' directory +2. Activate the plugin through the 'Plugins' menu in WordPress +3. Go to Settings > Bluesky Publisher to configure your connection ## Configuration -- **Client ID**: Your Bluesky client ID. -- **Client Secret**: Your Bluesky client secret. -- **Redirect URI**: Your Bluesky redirect URI. -## Usage -- Once configured, click on the "Login with Bluesky" button to authenticate and generate the API key. -- The plugin will automatically publish a formatted version of your new posts to Bluesky. +1. Get your Bluesky app password +2. Enter your Bluesky handle and app password in the settings +3. Choose your preferred post format +4. Start publishing! + +## Frequently Asked Questions + +### Where do I find my Bluesky app password? + +You can generate an app password in your Bluesky account settings under "App Passwords". + +### Why are my images always at the top of the post? + +This is how Bluesky displays image embeds - they will always appear at the top of the post regardless of formatting settings. + +### What happens if an error occurs during posting? + +Posts are added to a queue and the plugin will automatically retry failed posts. You can also manually retry posts from the post editor. + +## Changelog + +### 1.0.0 +* Initial release +* Customizable post formatting +* Image support with automatic resizing +* Queue management system +* Post meta box controls +* Token refresh functionality ## License -This plugin is licensed under the [GPLv2 or later](http://www.gnu.org/licenses/gpl-2.0.html). \ No newline at end of file + +This project is licensed under the MIT License - see below for details: + +``` +MIT License + +Copyright (c) 2024 Eugene Web Doctor + +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. +``` + +## Credits + +Developed by [Eugene Web Doctor](https://eugenewebdoctor.com) \ No newline at end of file