Update README.md

README.md

@@ -50,6 +50,29 @@ of "Takin' Off" Album from {@Herbie Hancock@}
 via {{USERNAME}} link below: {{URL}}
 ```
 
+A simple function to format tweet follows below.
+
+```python
+import re
+from urlextract import URLExtract
+extractor = URLExtract()
+
+def format_tweet(tweet):
+    # mask web urls
+    urls = extractor.find_urls(tweet)
+    for url in urls:
+        tweet = tweet.replace(url, "{{URL}}")
+    # format twitter account
+    tweet = re.sub(r"\b(\s*)(@[\S]+)\b", r'\1{\2@}', tweet)
+    return tweet
+
+target =  tweet = """Get the all-analog Classic Vinyl Edition of "Takin' Off" Album from @herbiehancock via @bluenoterecords link below: http://bluenote.lnk.to/AlbumOfTheWeek"""
+target_format = format_tweet(target)
+print(target_format)
+'Get the all-analog Classic Vinyl Edition of "Takin\' Off" Album from {@herbiehancock@} via {@bluenoterecords@} link below: {{URL}}'
+```
+
+
 We ask annotators to ignore those special tokens but label the verified users' mentions.