docs: updated to make everything clear

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: aldy505

README.md

@@ -1,6 +1,6 @@
 # Jokes Bapak2 API
 
-⚠ Still work in progress
+👋 Hey there! Still work in progress, if you'd like to contribute this while this repo is still growing, that would be so great!
 
 ## Brief explanation of what is this
 
@@ -9,7 +9,7 @@ This project will be a website like icanhazdadjokes but in Indonesian version an
 ## Project Directories
 
 * `api` - REST API service. Created with Go.
-* `client` - Front facing website (front end). Created with Vite.js
+* `client` - Front facing website (front end). Created with [Svelte Kit](https://kit.svelte.dev/).
 
 Anyway, later you can consume this API via a website (that will be created later on when this is finished) with a few endpoints:
 
@@ -38,16 +38,4 @@ See README files on each project directory for further instruction on how to run
 
 ## License
 
-Copyright 2021-present Jokes Bapak2 API Contributors
+Jokes Bapak2 API is licensed under [GNU GENERAL PUBLIC LICENSE v3 license](./LICENSE)
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

api/README.md

@@ -21,14 +21,14 @@ $ go build main.go
 
 | Name | Version | Type |
 | --- | --- | --- |
-| gofiber/fiber | v2.14.0 | Framework |
+| [gofiber/fiber](https://github.com/gofiber/fiber) | `v2.14.0` | Framework |
-| jackc/pgx | v4.11.0 | Database |
+| [jackc/pgx](https://github.com/jackc/pgx) | `v4.11.0` | Database |
-| go-redis/redis | v8.11.0 | Cache |
+| [go-redis/redis](https://github.com/go-redis/redis) | `v8.11.0` | Cache |
-| joho/godotenv | v1.3.0 | Config |
+| [joho/godotenv](https://github.com/joho/godotenv) | `v1.3.0` | Config |
-| getsentry/sentry-go | v0.11.0 | Logging |
+| [getsentry/sentry-go](https://github.com/getsentry/sentry-go) | `v0.11.0` | Logging |
-| aldy505/phc-crypto | v1.1.0 | Utils |
+| [aldy505/phc-crypto](https://github.com/aldy505/phc-crypto) | `v1.1.0` | Utils |
-| Masterminds/squirrel | v1.5.0 | Utils |
+| [Masterminds/squirrel](https://github.com/Masterminds/squirrel ) | `v1.5.0` | Utils |
-| aldy505/bob | v0.0.1 | Utils |
+| [aldy505/bob](https://github.com/aldy505/bob) | `v0.0.1` | Utils |
 
 ## Directory structure
 

client/README.md

@@ -1,25 +1,27 @@
-# create-svelte
+# Jokes Bapak2 API
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte);
+Still work in progress
 
-
+## Development
-## Developing
-
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
 
 ```bash
-yarn dev
+# Install modules
+$ yarn install
+
+# Run local server
+$ yarn dev
 
 # or start the server and open the app in a new browser tab
-yarn dev -- --open
+$ yarn dev -- --open
-```
 
-## Building
+# build everything
-
+$ yarn build
-Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
-
-```bash
-yarn build
 ```
 
 > You can preview the built app with `yarn preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.
+
+## Used packages
+
+| Name | Version | Type |
+| --- | --- | --- |
+| @sveltejs/kit | `next` | Framework |