Skip to content

Commit

Permalink
Fix: README to use SVG instead of markdown mermaid (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
flemay authored Feb 9, 2024
1 parent 94831f3 commit b067f80
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 42 deletions.
37 changes: 2 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@
# 3 Musketeers

<div align="center">

<img src="docs/public/img/hero-v2.svg" width="300">

**Test, build, and deploy your apps from anywhere, the same way!**

[![Build Status][linkGitHubActionsProjectBadge]][linkGitHubActionsProject]
[![Netlify Status][linkNetlifyProjectBadge]][linkNetlifyProject]
[![License][linkLicenseBadge]][linkLicense]

</div>

<details>
Expand Down Expand Up @@ -52,31 +50,7 @@

The 3 Musketeers is a pattern for developing software in a repeatable and consistent manner. It leverages Make as an orchestration tool to test, build, run, and deploy applications using Docker and Docker Compose. The Make and Docker/Compose commands for each application are maintained as part of the application’s source code and are invoked in the same way whether run locally or on a CI/CD server.

<!-- Copy of diagrams/overview.mmd -->
```mermaid
graph LR
host["**Host**
Linux
MacOS
Windows
CI/CD
..."]
make["**Make**
test
build
run
deploy
..."]
host-->make
make-->docker["Docker
Compose"]
container(("&nbsp;&nbsp;&nbsp;&nbsp;**Container(s)**&nbsp;&nbsp;&nbsp;&nbsp;
Go
Python
PostgreSQL
..."))
docker-->container
```
<img src="./diagrams/overview.mmd.svg" width="90%">

## Why?

Expand Down Expand Up @@ -106,14 +80,7 @@ _The demo was generated with VHS using the 3 Musketeers ([source](demo))._

Let's print out `Hello, World!` in the terminal using the 3 Musketeers. The command `make echo` will be calling Docker to run the command `echo 'Hello, World!'` inside a container.

<!-- Copy of diagrams/getting-started.mmd -->
```mermaid
graph LR
host[Host]-->make[make echo]
make-->docker["Docker"]
docker-->container(("echo 'Hello, World!'
(container)"))
```
<img src="./diagrams/getting-started.mmd.svg" width="90%">

### Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion diagrams/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ find *.mmd -type f \
-p /puppeteer-config.json \
-b transparent \
-i {}'
printf "Copy *.svg to docs/guide/assets"
printf "Copy *.svg to docs/guide/assets\n"
rm -fr /docs/guide/assets/*.svg
cp *.svg /opt/docs/guide/assets
4 changes: 2 additions & 2 deletions diagrams/overview.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ graph LR
deploy
...`"]
host-->make
make-->docker[Docker
Compose]
make-->docker["`**Docker**
**Compose**`"]
container(("`**Command**
&emsp;&emsp;(container)&emsp;&emsp;
Go
Expand Down
5 changes: 3 additions & 2 deletions diagrams/overview.mmd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit b067f80

Please sign in to comment.