Skip to content

Commit

Permalink
Readme improvements (#314)
Browse files Browse the repository at this point in the history
* Add screenshots to readme

* Fix relative image links

* Fix light color scheme

* add the actual img tag...

* Add a better title/CTA/link
  • Loading branch information
lewish authored Aug 5, 2024
1 parent a86649b commit 6559496
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# [asciiflow.com](https://asciiflow.com)

ASCIIFlow is a client-side only web based application for drawing ASCII diagrams. You can use it at [asciiflow.com](https://asciiflow.com).

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/asciiflow-scr-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/asciiflow-scr-light.png">
<img alt="ASCIIFlow screenshot" src="./assets/asciiflow-scr-light.png">
</picture>
</p>

## Contributing

### Installation

ASCIIFlow is built with [Bazel](https://docs.bazel.build/versions/4.0.0/getting-started.html).
Expand All @@ -18,7 +29,6 @@ npm install -g @bazel/ibazel
yarn global add @bazel/ibazel
```


### Running ASCIIFlow locally

After installation of Bazel/Bazelisk, you can run ASCIIFlow locally with:
Expand All @@ -32,3 +42,4 @@ Or without ibazel (won't do live reloading):
```
bazel run client:devserver
```

Binary file added assets/asciiflow-scr-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/asciiflow-scr-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6559496

Please sign in to comment.