From 176b919edf14e0e4c5cfaeb469da18d9602919eb Mon Sep 17 00:00:00 2001 From: erik Date: Thu, 30 May 2024 09:45:17 +0200 Subject: [PATCH] Update readme --- README.md | 48 +++++++++++++++++++++++------------------------- 1 file changed, 23 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e3e2c21..307eeac 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ # dda-masto-embed + ![build](https://github.com/DomainDrivenArchitecture/dda-masto-embed/workflows/build-it/badge.svg) [team@social.meissa-gmbh.de team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org) ## In brief -dda-masto-embed embedd either your timeline or answers to a specific post on your website. +dda-masto-embed embedd either your timeline or replies 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 +* in replies mode you can decide to show only favorited replies in order to do upfront moderation * 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/) +* example for embedding replies 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) @@ -19,30 +21,22 @@ dda-masto-embed embedd either your timeline or answers to a specific post on you ### css and html as base Uses a generalized HTML structure with descriptive classes and css grid for styling. +The structure in the css follows the html structure. Both accound mode and replies mode are styled there. + Re-styling your timeline should now be a breeze. -## Development & mirrors -Development happens at: https://repo.prod.meissa.de/meissa/dda-masto-embed - -Mirrors are: -* https://codeberg.org/meissa/dda-masto-embed (issues and PR) -* https://gitlab.com/domaindrivenarchitecture/dda-masto-embed (CI) -* https://github.com/DomainDrivenArchitecture/dda-masto-embed - ## Include a timeline Including a timeline needs the following html. The div with id `masto-embed` configures the timeline to be shown. We use bootstrap for rough styling. More styling is up to you at the moment, help is welcome :-) -``` +```html masto-embed - +
masto-embed - +
``` + Reference: + * `id` has to be `masto-embed` * `account_name` is the name of your account. * `host_url` the url of your mastodon instance. * `replies_to` the id of your post. * `filter_favorited=` true will show only favorited replies, false will show every answer. - ## Dev setup -``` +```bash npm install -g npx npm install -g shadow-cljs npm install -g source-map-support --save-dev @@ -109,16 +103,17 @@ open browser at http://localhost:8080 Connect your repl for :frontend - ## Run the tests -``` +```bash shadow-cljs compile test ``` ## Releasing + ### prod release -``` + +```bash #adjust version vi package.json git commit -am 'releasing' @@ -131,9 +126,12 @@ git commit -am "version bump" && git push ``` ## Development & mirrors + Development happens at: https://repo.prod.meissa.de/meissa/dda-masto-embed Mirrors are: + +* https://codeberg.org/meissa/dda-masto-embed (issues and PR) * https://gitlab.com/domaindrivenarchitecture/dda-masto-embed (CI issues and PR) * https://github.com/DomainDrivenArchitecture/dda-masto-embed