meissa/dda-masto-embed
6
0
Fork 0
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
erik 2024-05-29 16:19:37 +02:00
parent f79529e0ea
commit 39333ea4fe
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -5,17 +5,22 @@
## In brief
dda-masto-embed embedd either your timeline or answers to an specific post on your website.
dda-masto-embed embedd either your timeline or answers to a specific post on your website.
* Uses JS, **no intermediate server** required,
* in answer mode you can decide to show only favorited answers in order to do upfront moderation
* example for embedding a timeline at [meissa-gmbh.de/news](https://meissa-gmbh.de/pages/news/)
* example for embedding answers to a specific post at [meissa-gmbh.de/sustainibility_microplastic](https://meissa-gmbh.de/pages/about_meissa/gemeinwohl/sustainability_microplastic/)
* example for embedding a timeline at [meissa.de/news](https://meissa.de/news/)
* example for embedding answers to a specific post at [meissa.de/sustainibility_microplastic](https://meissa.de/about-meissa/03plastik-aktion/)
* Download latest version at:
* [dda-masto-embed.js](https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js)
* [dda-masto-embed.js.sha256](https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js.sha256)
* [dda-masto-embed.js.sha512](https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js.sha512)
* It is **OpenSource** - published under the Apache License, Version 2.0
### css and html as base
Uses a generalized HTML structure with descriptive classes and css grid for styling.
Re-styling your timeline should now be a breeze.
## Development & mirrors
Development happens at: https://repo.prod.meissa.de/meissa/dda-masto-embed
@ -24,9 +29,6 @@ Mirrors are:
* https://gitlab.com/domaindrivenarchitecture/dda-masto-embed (CI)
* https://github.com/DomainDrivenArchitecture/dda-masto-embed
## How it looks
![masto-embed-example.png](doc/masto-embed-example.png)
## Include a timeline
Including a timeline needs the following html. The div with id `masto-embed` configures the timeline to be shown.