Skip to content

Commit

Permalink
docs: add a readme on how tweets folder is meant to be used
Browse files Browse the repository at this point in the history
  • Loading branch information
sassman committed May 18, 2024
1 parent 0ea0538 commit 46e00de
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions tweets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# The tweets/ folder

To create a new tweet create a new `*.tweet` file in this `tweets/` folder.

<kbd>[Create new tweet](../../../new/main/?filename=tweets/<your-path>.tweet)</kbd>

## Example

Create a new file `tweets/hello-world.tweet` with the content

> Hello, world!
You can use subfolders, e.g. `tweets/2019-02/hello-world.tweet`, as long as the file is in the `tweets/` folder and has the `.tweet` file extension

## Notes

- Only newly created files are handled, deletions, updates or renames are ignored.
- `*.tweet` files will not be created for tweets you send out directly from twitter.com
- If you need to rename an existing tweet file, please do so locally using [`git mv old_filename new_filename`](https://help.github.com/en/articles/renaming-a-file-using-the-command-line), otherwise it may occur as deleted and added which would trigger a new tweet.

## Questions?

The full docs on twitter together are here: https://github.com/marketplace/actions/twitter-together

0 comments on commit 46e00de

Please sign in to comment.