Skip to content

Commit

Permalink
Update README.md with screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
rafal06 committed Aug 9, 2022
1 parent 1143842 commit 3499732
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# Grasswave CDN [WIP]
A stupidly simple and easy to self-host, personal server for file hosting on the web
# Grasswave CDN
A stupidly simple and easy to self-host, personal server for file hosting on the web. Written in Rust.

Thanks, [@Maciejowski](https://github.com/maciejowski2006/), for the stylesheet!

## Screenshots

<img src="screenshots/desktop.png" alt="screenshot of the main page">
<details>
<summary>Show more</summary>
<h3>Mobile layout</h3>
<img src="screenshots/mobile.png" alt="mobile layout" />
<h3>Search</h3>
<img src="screenshots/search.png" alt="search" />
<h3>Tag search</h3>
<img src="screenshots/tag-search.png" alt="tag search" />
</details>

## How to use
For every file you want to publish, create a seperate directory in the `files` folder, and place the files inside of them. In every directory, create a file named `info.toml`.
```
Expand All @@ -25,6 +38,3 @@ tags = ["lorem", "ipsum", "dolor"]
path = "lorem.tar.xz"
```
Run the executable, and that's it! You can visit it in the browser at `http://127.0.0.1:8000`

---
Currently work in progress
Binary file added screenshots/desktop.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 screenshots/mobile.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 screenshots/search.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 screenshots/tag-search.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 3499732

Please sign in to comment.