Skip to content

Commit bfd12d3

Browse files
committed
TASK: improve readme
1 parent af7b281 commit bfd12d3

File tree

1 file changed

+34
-21
lines changed

1 file changed

+34
-21
lines changed

readme.md

+34-21
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,16 @@ This package currently only requires Neos >= `4.3` and `guzzlehttp/guzzle`
3838

3939
![BetterEmbed example blog post]
4040

41+
##### API result
4142
```json
4243
{
43-
"url": "https://www.neoscon.io/",
44-
"itemType": "Neos Conference | Tech- and Developer Conference",
45-
"title": "Neos Conference 2019 in Dresden",
46-
"body": "Neos Conference is designed for the community and to take everyone further. Because our audience deserves the best content. Everytime.",
47-
"thumbnailUrl": "https://www.neoscon.io/_Resources/Persistent/c799ecede3620e09013ac72d9f429942764c6a4e/neos_conference_2019-dresden-primary-web.jpg",
48-
"authorName": "@neoscms",
49-
"authorUrl": "https://twitter.com/neoscms"
44+
"url": "https://www.theverge.com/2020/3/23/21175407/remote-work-working-from-home-guide-how-to-tips-video-conference-calls-laptops-zoom-slack",
45+
"itemType": "The Verge",
46+
"title": "The Verge Guide to Working at Home",
47+
"body": "Tips and tricks on being a remote worker",
48+
"thumbnailUrl": "https://cdn.vox-cdn.com/thumbor/NdRt13PSWplEE-lZkxFEPyc4a8U=/0x146:2040x1214/fit-in/1200x630/cdn.vox-cdn.com/uploads/chorus_asset/file/19822359/acastro_200319_3941_wfhGuide_0003.jpg",
49+
"authorName": "Barbara Krasnoff",
50+
"publishedAt": "2020-03-23T08:00:00-04:00"
5051
}
5152
```
5253

@@ -56,17 +57,19 @@ This package currently only requires Neos >= `4.3` and `guzzlehttp/guzzle`
5657
![BetterEmbed example Youtube 2]
5758
![BetterEmbed example Youtube 3]
5859

60+
##### API result
61+
5962
```json
6063
{
61-
"embedHtml": "<iframe width=\"480\" height=\"270\" src=\"https://www.youtube.com/embed/4DVD03IlXIs?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>",
62-
"url": "https://www.youtube.com/watch?v=4DVD03IlXIs",
63-
"itemType": "YouTube",
64-
"title": "Why editors love Neos CMS | Open Source CMS",
65-
"body": "Neos is not your everyday Content Management System. Neos is based upon the idea to make editors and developers happy and to bring joy to their daily work. T...",
66-
"thumbnailUrl": "https://i.ytimg.com/vi/4DVD03IlXIs/hqdefault.jpg",
67-
"authorName": "Neos CMS",
68-
"authorUrl": "https://www.youtube.com/channel/UCQndryIh2s9i3htDrpb6tiw",
69-
"publishedAt": "2019-03-27T00:00:00+00:00"
64+
"embedHtml": "<iframe width=\"480\" height=\"270\" src=\"https://www.youtube.com/embed/-ZHY85m63k0?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>",
65+
"url": "https://www.youtube.com/watch?v=-ZHY85m63k0",
66+
"itemType": "YouTube",
67+
"title": "Neos Con 2019 Teaser Trailer | Neos Conference",
68+
"body": "Only a few weeks and tickets left till the Neos Con 2019 in Dresden from 10th to 11th May. Be sure to save your spot: https://www.eventbrite.de/e/neos-confer...",
69+
"thumbnailUrl": "https://i.ytimg.com/vi/-ZHY85m63k0/hqdefault.jpg",
70+
"authorName": "Neos CMS",
71+
"authorUrl": "https://www.youtube.com/channel/UCQndryIh2s9i3htDrpb6tiw",
72+
"publishedAt": "2019-03-29T00:00:00+00:00"
7073
}
7174
```
7275

@@ -76,6 +79,20 @@ This package currently only requires Neos >= `4.3` and `guzzlehttp/guzzle`
7679
![BetterEmbed example Twitter 2]
7780
![BetterEmbed example Twitter 3]
7881

82+
```json
83+
{
84+
"embedHtml": "<blockquote class=\"twitter-tweet\"><p lang=\"en\" dir=\"ltr\">What a blast! ☺️ Two days full of exciting talks, conversations, networking and way more! Thank you all for being part of it! We hope to see you all again soon! 🥰 <a href=\"https://twitter.com/hashtag/neoscon?src=hash&amp;ref_src=twsrc%5Etfw\">#neoscon</a> <a href=\"https://twitter.com/hashtag/neos?src=hash&amp;ref_src=twsrc%5Etfw\">#neos</a> <a href=\"https://twitter.com/hashtag/community?src=hash&amp;ref_src=twsrc%5Etfw\">#community</a> <a href=\"https://t.co/nSaZCU2bba\">pic.twitter.com/nSaZCU2bba</a></p>&mdash; The Neos Project (@neoscms) <a href=\"https://twitter.com/neoscms/status/1127605365019947008?ref_src=twsrc%5Etfw\">May 12, 2019</a></blockquote>\n<script async src=\"https://platform.twitter.com/widgets.js\" charset=\"utf-8\"></script>",
85+
"url": "https://twitter.com/neoscms/status/1127605365019947008",
86+
"itemType": "Twitter",
87+
"title": "The Neos Project on Twitter",
88+
"body": "“What a blast! ☺️ Two days full of exciting talks, conversations, networking and way more! Thank you all for being part of it! We hope to see you all again soon! 🥰 #neoscon #neos #community”",
89+
"thumbnailUrl": "https://pbs.twimg.com/media/D6YN2puXkAE_QLr.jpg:large",
90+
"authorName": "The Neos Project",
91+
"authorUrl": "https://twitter.com/neoscms",
92+
"publishedAt": "2019-05-12T16:04:03+00:00"
93+
}
94+
```
95+
7996
## Rendering
8097

8198
The package includes a default rendering component together with the according Javascript and CSS sources.
@@ -106,10 +123,6 @@ You will find the imported assets in the "BetterEmbed" asset collection within t
106123
The package is based on the BetterEmbed API endpoint.
107124
You can read the API description [here][swagger] and test URLs.
108125

109-
## Beta Release
110-
111-
Please note that this is currently a beta release. If you find any issues pls report them or create PR - thx!
112-
113126
## Issues and PRs
114127

115128
Feel free to create issues for PRs if you like.
@@ -126,6 +139,6 @@ Feel free to create issues for PRs if you like.
126139
[betterembed example youtube 3]: Documentation/BetterEmbed-Example-Youtube-3.png
127140
[betterembed example twitter 1]: Documentation/BetterEmbed-Example-Twitter-1.png
128141
[betterembed example twitter 2]: Documentation/BetterEmbed-Example-Twitter-2.png
129-
[betterembed example twitter 3]: Documentation/BetterEmbed-Example-Youtube-3.png
142+
[betterembed example twitter 3]: Documentation/BetterEmbed-Example-Twitter-3.png
130143
[betterembed media module]: Documentation/BetterEmbed-Media-Module.png
131144
[swagger]: https://api.betterembed.com/swagger/index.html

0 commit comments

Comments
 (0)