Skip to content

Commit c28c8da

Browse files
committed
feat: finally update README
1 parent c860843 commit c28c8da

File tree

1 file changed

+32
-8
lines changed

1 file changed

+32
-8
lines changed

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,42 @@
1-
# geode
1+
<h1 align="center">Geode</h1>
2+
<h3 align="center">An alternative Crystal package manager</h3>
3+
<hr>
24

3-
TODO: Write a description here
5+
Geode is a drop-in replacement for [Shards](https://github.com/crystal-lang/shards) with additional features and tools for a better Crystal experience.
46

57
## Installation
68

7-
TODO: Write installation instructions here
9+
### From Release
810

9-
## Usage
11+
See the [releases page](https://github.com/devnote-dev/geode/releases) for available packaged binaries.
12+
13+
#### Linux
14+
15+
```sh
16+
curl -L https://github.com/devnote-dev/geode/releases/download/nightly/geode-nightly-linux-x86_64.tar.gz -o geode.tar.gz
17+
tar -xvf geode.tar.gz -C /usr/local/bin
18+
```
19+
20+
#### Windows (PowerShell)
1021

11-
TODO: Write usage instructions here
22+
```ps1
23+
Invoke-WebRequest "https://github.com/devnote-dev/geode/releases/download/nightly/geode-nightly-windows-x86_64-msvc.zip" -OutFile geode.zip
24+
Expand-Archive .\geode.zip .
25+
```
1226

13-
## Development
27+
### From Source
28+
29+
[Crystal](https://crystal-lang.org/) version 1.5.0 or higher is required to build Geode. Make sure to add the `bin/` directory to `PATH` or move the Geode binaries to a directory in `PATH`.
30+
31+
```sh
32+
git clone https://github.com/devnote-dev/geode
33+
cd geode
34+
shards build
35+
```
36+
37+
## Usage
1438

15-
TODO: Write development instructions here
39+
TODO.
1640

1741
## Contributing
1842

@@ -26,4 +50,4 @@ TODO: Write development instructions here
2650

2751
- [Devonte W](https://github.com/devnote-dev) - creator and maintainer
2852

29-
© 2023 devnote-dev
53+
© 2023 devnote-dev

0 commit comments

Comments
 (0)