From 8013c74350de51637b42262aab832d1510660d8a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=82=BFrat?= <92316026+coinselor@users.noreply.github.com>
Date: Wed, 12 Jun 2024 17:00:58 +0100
Subject: [PATCH] move cex readme to archive and update main readme
---
README.md | 129 +++++++++++++++++++++++++++++-----------------
archive/README.md | 73 ++++++++++++++++++++++++++
tweets/README.md | 37 -------------
3 files changed, 155 insertions(+), 84 deletions(-)
create mode 100644 archive/README.md
delete mode 100644 tweets/README.md
diff --git a/README.md b/README.md
index 4b73b86..fab6a11 100644
--- a/README.md
+++ b/README.md
@@ -1,73 +1,108 @@
-# CEX Fundraiser - Open until May 3rd, 2024
+# zenon-network/twitter
-
+Welcome to the Zenon Network's Twitter GitHub repository. This project allows you to create and manage tweets directly from this repository. Follow the instructions below to get started:
-This document provides all the necessary details about the CEX fundraising event organized by the Zenon Network community, including a short bio about participating members in the multisignature wallet, and how you can contribute.
+## The `tweets/` Folder
-For more information, refer to the original [discussion](https://forum.zenon.org/t/cex-fundraiser-open-until-may-3rd-2024).
+To create a new tweet, create a new `*.tweet` file in the `tweets/` folder.
-## Fundraiser Details
-- Objective: Raise funds for a CEX listing.
-- Target goal: **$80K USDT**
-- Recommended currencies: $USDT / $USDC, $ETH, $WBTC, $wZNN, $ZNN
+### Example
-## How to Contribute
-:warning: ETHEREUM NETWORK ONLY :warning:
-
-Please, send donations to the following Ethereum address or ENS name.
-
-Zenon Network Fundraising Multisignature Address:
-`0xA06Ded756B823fCe92d5Da890aEd1C2d6677F2B3`
+Create a new file `tweets/dd-mm-yy-hello-world.tweet` with the content:
-
+```
+Hello, world!
+```
-Alternatively, you can use the following ENS (Ethereum Name Service) domain name on compatible wallets:
-`zenonnetwork.eth`
+### File Naming Convention
+File names must follow the dd-mm-yy-tweet-name.tweet nomenclature. This format helps maintain a clear and organized structure, ensuring each tweet is easily identifiable by the date of creation and a descriptive name.
+### File Naming Convention
----
+File names must follow the `dd-mm-yy-tweet-name.tweet` nomenclature. For example, `12-06-24-hello-world.tweet`.
+
+
+## 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 be seen as deleted and added, which would trigger a new tweet.
+- Your message must fit into a single tweet.
+
+
+
+## Advanced Tweeting
+
+Beyond tweeting out plain-text tweets, the twitter-together github action also supports creating polls, threading a chain of tweets, and adding images to tweets.
+
+### Polls
+
+Polls can be included directly in the body of tweet like so:
-⚠️ NETWORK OF MOMENTUM ONLY ⚠️
-
+```
+What is your favorite color?
-Due to popular demand, [SultanOfStaking has enabled his SOS Community Address to receive native ZNN donations](https://twitter.com/sultanofstaking/status/1778099355821478357?s=61&t=Q30TfKSdOpq7z9EKyk_Dbg) for the duration of the event.
+( ) Red
+( ) Blue
+( ) Green
+```
-Please send donations to the following NoM address:
+A poll can also be defined in frontmatter, rather than in the tweet body, like so:
-SOS Community Address:
-`z1qrcc2c65w4d3zested2wl00hfyhr7022h92l92`
+```
+---
+poll:
+ - Red
+ - Blue
+ - Green
+---
+
+What is your favorite color?
+```
-
+### Include Media
-## CEX Multisig Signers - 6 out of 8 signatures required - *powered by [Safe](safe.global)*
+To include media items with your tweet, include the `media` frontmatter item as an array with each item having a `file` property and an optional `alt` property. The `file` property should be the name of a file within the `media` directory of your repository (same level as the `tweets` directory).
+(Note: Although alt text can be set in frontmatter, it is not yet actually passed to Twitter due to library limitations).
-### [Shaimo](https://twitter.com/shaimo) `@shaimo`
-An og amongst ogs. Participated in xStakes, the original inception of Zenon.
+```
+---
+media:
+ - file: cat.jpg
+ alt: A cat
+ - file: dog.jpg
+ alt: A dog
+---
-### [SultanOfStaking](https://twitter.com/SultanOfStaking) `@SultanOfStaking`
-Brand to one of the most delegated pillars historically. Creator of #FreeZenonFriday.
+Here are some cute animals!
+```
-### [sumamu](https://twitter.com/su_mamu_) `@su_mamu_`
-Nominated for HyperCore. Part of the Multichain team that developed the EVM bridge. Rockstar dev.
+### Thread a Chain of Tweets
-### [DeeZNNutz](https://twitter.com/0x3639) `@0x3639`
-One of the most engaged members of the Zenon community, contributing on multiple fronts and currently serving as the lead maintainer of the zenon-network GitHub repository.
+To thread a chain of tweets, use `---` to delimit each tweet in the file. You can optionally set `threadDelimiter` in the frontmatter to change the delimiter for the next tweet in the thread. Each tweet in a thread supports its own frontmatter.
-### [coinselor](https://twitter.com/coinselor) `@coinselor`
-Arquitect behind ATSocy, a publication about NoM. Author of "The REAL Zenon Enigma", an article trying to create a holistic view of NoM's BTC interoperability. Maintainer of Zenon Social channels.
+```
+---
+media:
+ - file: cat.jpg
+ alt: A cat
+ - file: dog.jpg
+ alt: A dog
+---
-### [Stark](https://twitter.com/Stark_of_Zenon) `@Stark_of_Zenon`
-Outspoken alien and creator of "Zenon Core", an ordinals collection that highlights the Zenon gensis. Owner of Stark Pillar. Maintainer of Zenon Social channels.
+Here are some cute animals!
-### [Zashu](https://twitter.com/zashounet) `@zashounet`
-A well-known alien with deep knowledge of and curiosity about Zenon's mysterious origins. Maintainer of Zenon Social channels.
+---
+---
+poll:
+ - Cat
+ - Dog
+---
-### [Sugoi](https://twitter.com/sugoibtc) `@sugoibtc`
-Longstanding member of Zenon's first awareness initiative (ZIF). Owner of the Outlawz Pillar. Maintainer of Zenon Social channels.
+Which one is cuter?
+```
-## How to Track Donation Amounts
-To monitor the donations, please refer to the following wallet addresses in a blockchain explorer:
-- [Zenon Network Fundraising Address (ETH)](https://etherscan.io/address/0xA06Ded756B823fCe92d5Da890aEd1C2d6677F2B3)
-- [SOS Community Address (NoM)](https://zenonhub.io/explorer/account/z1qrcc2c65w4d3zested2wl00hfyhr7022h92l92)
+## Questions?
+If you have any further questions or suggestions, please join the conversation on our [Discord](https://discord.gg/zenonnetwork).
diff --git a/archive/README.md b/archive/README.md
new file mode 100644
index 0000000..4b73b86
--- /dev/null
+++ b/archive/README.md
@@ -0,0 +1,73 @@
+# CEX Fundraiser - Open until May 3rd, 2024
+
+
+
+This document provides all the necessary details about the CEX fundraising event organized by the Zenon Network community, including a short bio about participating members in the multisignature wallet, and how you can contribute.
+
+For more information, refer to the original [discussion](https://forum.zenon.org/t/cex-fundraiser-open-until-may-3rd-2024).
+
+## Fundraiser Details
+- Objective: Raise funds for a CEX listing.
+- Target goal: **$80K USDT**
+- Recommended currencies: $USDT / $USDC, $ETH, $WBTC, $wZNN, $ZNN
+
+## How to Contribute
+:warning: ETHEREUM NETWORK ONLY :warning:
+
+Please, send donations to the following Ethereum address or ENS name.
+
+Zenon Network Fundraising Multisignature Address:
+`0xA06Ded756B823fCe92d5Da890aEd1C2d6677F2B3`
+
+
+
+Alternatively, you can use the following ENS (Ethereum Name Service) domain name on compatible wallets:
+`zenonnetwork.eth`
+
+
+---
+
+⚠️ NETWORK OF MOMENTUM ONLY ⚠️
+
+
+Due to popular demand, [SultanOfStaking has enabled his SOS Community Address to receive native ZNN donations](https://twitter.com/sultanofstaking/status/1778099355821478357?s=61&t=Q30TfKSdOpq7z9EKyk_Dbg) for the duration of the event.
+
+Please send donations to the following NoM address:
+
+SOS Community Address:
+`z1qrcc2c65w4d3zested2wl00hfyhr7022h92l92`
+
+
+
+## CEX Multisig Signers - 6 out of 8 signatures required - *powered by [Safe](safe.global)*
+
+
+### [Shaimo](https://twitter.com/shaimo) `@shaimo`
+An og amongst ogs. Participated in xStakes, the original inception of Zenon.
+
+### [SultanOfStaking](https://twitter.com/SultanOfStaking) `@SultanOfStaking`
+Brand to one of the most delegated pillars historically. Creator of #FreeZenonFriday.
+
+### [sumamu](https://twitter.com/su_mamu_) `@su_mamu_`
+Nominated for HyperCore. Part of the Multichain team that developed the EVM bridge. Rockstar dev.
+
+### [DeeZNNutz](https://twitter.com/0x3639) `@0x3639`
+One of the most engaged members of the Zenon community, contributing on multiple fronts and currently serving as the lead maintainer of the zenon-network GitHub repository.
+
+### [coinselor](https://twitter.com/coinselor) `@coinselor`
+Arquitect behind ATSocy, a publication about NoM. Author of "The REAL Zenon Enigma", an article trying to create a holistic view of NoM's BTC interoperability. Maintainer of Zenon Social channels.
+
+### [Stark](https://twitter.com/Stark_of_Zenon) `@Stark_of_Zenon`
+Outspoken alien and creator of "Zenon Core", an ordinals collection that highlights the Zenon gensis. Owner of Stark Pillar. Maintainer of Zenon Social channels.
+
+### [Zashu](https://twitter.com/zashounet) `@zashounet`
+A well-known alien with deep knowledge of and curiosity about Zenon's mysterious origins. Maintainer of Zenon Social channels.
+
+### [Sugoi](https://twitter.com/sugoibtc) `@sugoibtc`
+Longstanding member of Zenon's first awareness initiative (ZIF). Owner of the Outlawz Pillar. Maintainer of Zenon Social channels.
+
+## How to Track Donation Amounts
+To monitor the donations, please refer to the following wallet addresses in a blockchain explorer:
+- [Zenon Network Fundraising Address (ETH)](https://etherscan.io/address/0xA06Ded756B823fCe92d5Da890aEd1C2d6677F2B3)
+- [SOS Community Address (NoM)](https://zenonhub.io/explorer/account/z1qrcc2c65w4d3zested2wl00hfyhr7022h92l92)
+
diff --git a/tweets/README.md b/tweets/README.md
deleted file mode 100644
index f61c379..0000000
--- a/tweets/README.md
+++ /dev/null
@@ -1,37 +0,0 @@
-# The tweets/ folder
-
-To create a new tweet create a new `*.tweet` file in this `tweets/` folder.
-
-[Create new tweet](../../../new/main/?filename=tweets/.tweet)
-
-## 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
-
-## Create a tweet with a twitter poll
-
-**Note**: The configured twitter account needs to be authorized to use Twitter's Ads API in order to send tweets including a poll.
-
-A tweet including a poll must end with 2-4 options in the following format
-
-> Here is some text
->
-> ( ) option A
-> ( ) option B
-> ( ) option C
-> ( ) option D
-
-## 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.
-- your message must fit into a single tweet
-
-## Questions?
-
-If you have any further questions or suggestions, please create an issue at https://github.com/twitter-together/action/issues/new