Update docs

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: Crystal CI
+on:
+  pull_request:
+    branches: [ "main" ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - uses: crystal-lang/install-crystal@v1
+        with:
+          crystal: 1.6.2
+      - name: Download source
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: shards install
+      - name: Run tests
+        run: crystal spec

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Crystal Docs Generation
+
+on:
+  push:
+    branches: [ "main" ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - uses: crystal-lang/install-crystal@v1
+      with:
+        crystal: 1.6.2
+    - uses: actions/checkout@v4
+    - name: Generate docs
+      run: crystal docs
+    - name: Move docs to _site
+      run: mv docs/ _site/
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Pauline De Polonia <paudepolonia000@yahoo.com>
+Copyright (c) 2022-2024 Hostari Philippines, Inc. <eng@hostari.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,6 @@
 # thunderstore_downloader
 
-A crystal wrapper to download and unzip thunderstore package versions and walk through each files within the folder to get their SHA256 hashes.
+Downloads and unzips thunderstore package versions and walks through each file within the folder to get its SHA256 hash.
 
 ## Installation
 
@@ -20,12 +20,6 @@ A crystal wrapper to download and unzip thunderstore package versions and walk t
 require "thunderstore_downloader"
 ```
 
-TODO: Write usage instructions here
-
-## Development
-
-TODO: Write development instructions here
-
 ## Contributing
 
 1. Fork it (<https://github.com/your-github-user/thunderstore_downloader/fork>)
@@ -36,4 +30,5 @@ TODO: Write development instructions here
 
 ## Contributors
 
-- [Pauline De Polonia](https://github.com/your-github-user) - creator and maintainer
+- [Pauline De Polonia](https://github.com/paula4230) - creator
+- [Xavi Ablaza](https://github.com/xaviablaza) - maintainer

shard.yml

@@ -1,9 +1,10 @@
 name: thunderstore_downloader
-version: 0.1.0
+version: 1.0.0
 
 authors:
   - Pauline De Polonia <[email protected]>
+  - Xavi Ablaza <[email protected]>
 
-crystal: 1.4.1
+crystal: ~> 1.6.2
 
 license: MIT

src/thunderstore_downloader.cr

@@ -2,7 +2,7 @@ require "json"
 require "http/client"
 
 module ThunderstorePackageDownloader
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end
 
 require "./thunderstore_downloader/**"