Skip to content

Commit 64d3c73

Browse files
Fill out README
1 parent 9111d4a commit 64d3c73

File tree

1 file changed

+8
-21
lines changed

1 file changed

+8
-21
lines changed

README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
1-
# website
1+
# Gears' Website
22

3-
[![Package Version](https://img.shields.io/hexpm/v/website)](https://hex.pm/packages/website)
4-
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/website/)
3+
Code for [my website](https://gearsco.de), written in [Gleam](https://gleam.run),
4+
using [Lustre](https://lustre.build) and [Lustre SSG](https://hexdocs.pm/lustre_ssg).
55

6-
```sh
7-
gleam add website@1
8-
```
9-
```gleam
10-
import website
6+
I have recently restructured the website from a multi-page site to an SPA, so for
7+
now Lustre SSG is overkill for what I need, and the codebase is a little messy.
8+
I do want to eventually make a blog and other pages for this site, so at some point
9+
it will get another rewrite.
1110

12-
pub fn main() {
13-
// TODO: An example of the project in use
14-
}
15-
```
16-
17-
Further documentation can be found at <https://hexdocs.pm/website>.
18-
19-
## Development
20-
21-
```sh
22-
gleam run # Run the project
23-
gleam test # Run the tests
24-
```
11+
For an example of Gleam/Lustre SSG, see: https://github.com/giacomocavalieri/giacomocavalieri.me

0 commit comments

Comments
 (0)