Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rstockm authored Aug 15, 2023
1 parent 219e4f4 commit f80f29e
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# mastothread
An intuitive web tool to seamlessly split and format long texts into manageable chunks for social media
# Mastothread

An intuitive web tool to seamlessly split and format long texts into manageable chunks for Mastodon threads.

<img width="600" alt="image" src="https://github.com/rstockm/mastothread/assets/3195116/6e97e506-e4cb-4672-ab22-6e551b01de56">


## Features

- **Text Splitting**: Automatically divides long texts into Mastodon-friendly chunks of up to 500 characters.
- **Manual Splitting**: Insert `---` into your text to indicate manual split points.
- **Link, Hashtag, and Username Formatting**: Enhances readability by auto-formatting links, hashtags, and complete usernames.
- **Adjustable Character Limit**: Customize the chunk size as per your preference.
- **Real-time Preview**: Visualize how your text will appear as separate Mastodon posts.
- **Copy to Clipboard**: Quick copy buttons for every chunk, which turn green upon being clicked to indicate a successful copy action.
- **Dynamic Subtitles**: Catchy, rotating subtitles to make your Mastothread experience memorable.

## Technology Stack

- **HTML/CSS**: Basic building blocks of the web.
- [**Bootstrap**](https://getbootstrap.com/): Open-source CSS framework for responsive design.
- [**jQuery**](https://jquery.com/): Fast, small, and feature-rich JavaScript library.

## Usage

1. Navigate to the Mastothread web page.
2. In the "Write your Text" section, input your lengthy text.
3. Adjust the character limit or enable pagination if needed.
4. View the real-time preview on the right. Use the "Copy" button to copy individual posts.
5. Paste the posts into your Mastodon app of choice.
6. Enjoy your Mastodon threads with ease!

## AI-Guided Development: A Proof of Concept

Mastothread may serve as an example of how artificial intelligence can aid and accelerate the software development process. The development of this version of the app was guided by OpenAI's GPT-4, a large language model.

In this process, the human developer posed problems, asked questions, and described the desired features and functionalities of the application. GPT-4 then provided solutions, answered queries, generated code snippets, and suggested optimal ways to implement these features.

Every single line of code was written by ChatGPT4.
Including this README and the catchphrases.

0 comments on commit f80f29e

Please sign in to comment.