Get the first draft up there

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        version: [stable, unstable, development-target]
+    container:
+      image: ghcr.io/elementary/docker:${{ matrix.version }}
+
+    steps:
+    - uses: actions/checkout@v5
+    - name: Install Dependencies
+      run: |
+        apt update
+        apt install -y meson valac libjson-glib-dev
+    - name: Build
+      run: |
+        meson setup build --prefix=/usr
+        ninja -C build
+        ninja -C build install
+
+  lint:
+    runs-on: ubuntu-latest
+
+    container:
+      image: valalang/lint
+
+    steps:
+    - uses: actions/checkout@v5
+    - name: Lint
+      run: io.elementary.vala-lint -d .

README.md

@@ -1,6 +1,58 @@
 # libfridge
 
-Simple Vala App Storage Library
+A simple, hassle-free storage library to keep your data fresh.
+Ready out of the box, comprehensive for vala newcomers, and built to be reliable and out of your way.
+
+This library primarily contains:
+
+- StringStorage: Store a string, any size.
+- JsonStorage: Store an array of Json.Node or Json.Objects 
+- Static variables to keep track of your data files
+
+## Features:
+- [x] Smart instancing: Each instance is its own distinct file, and you can let Fridge deal with that.
+- [x] Cache: By default a cache lets you access content faster
+- [x] Optional error handling: You can connect to the error() signal. If you want to.
+- [x] Optional Json: You can rely on pretty pure vala here if you want to keep it light
+- [x] Add a contains() method, so people can do if (var in storageinstance)
+- [x] Handy: Static values to help you manage your datadir
+
+Wishlist of features:
+- [ ] Integrated debounce saving?
+- [ ] More agressive trying to load/save in case of errors
+- [ ] Optional SQL storage i think? Something stupid: One key one value. Optional like the json one
+- [ ] Save to binary?
+- [ ] Make shit async for cases with heavy objects?
+- [ ] encrypted storage ? using some combined magic of libsecret and some traditional encrypt library? maybe a salt and a randomly generated password? so user only need unlock their keyring, and the random gen gets pulled out invisibly.
+
+
+
+## How to use: Crash course
+
+All instances are meant to represent a file on disk. Simply declare:
+
+```
+var mystorage = new Fridge.json_storage();
+```
+
+Or any variant depending what you want to store... And you are good to go!
+Save by doing:
+
+```
+mystorage.content = thing_to_save;
+```
+
+Access it by doing:
+
+```
+var thing_to_load = mystorage.content;
+```
+
+## Apps using Fridge:
+
+- [ ] Jorts (https://github.com/ellie-commons/Jorts) 
+- [ ] You can expand this list! 
+
 
 ## Build Instructions
 
@@ -24,6 +76,41 @@ To install libfridge:
 ninja install
 ```
 
+
+## Add to your meson
+
+With Fridge installed on your puter, simply add to your dependencies:
+
+```
+  dependency('libfridge-0.1'),
+```
+
+
+## Add to your flatpak project
+
+Simply copy the in your manifest before your app sources:
+
+```
+  - name: libfridge
+    buildsystem: meson
+    sources:
+      - type: git
+        url: https://github.com/vala-community/libfridge.git
+        tag: 0.0.1
+        commit: [NOT DONE YET]
+        x-checker-data:
+          type: git
+          tag-pattern: '^([\d.]+)$'
+```
+
+By default JsonStorage is included. If you do not use it, and wish to skip having a json dependency, you can add immediately after the buildsystem line:
+
+```
+    config-opts:
+      - -Denable_json=false
+```
+
+
 ## Documentation
 
 By default, documentation is built by default using [`valadoc`](https://docs.vala.dev/developer-guides/documentation/valadoc-guide.html)

demo/demo.vala

@@ -0,0 +1,16 @@
+// Testing and demo purposes
+// valac --pkg libfridge demo.vala
+
+  public static int main (string[] args) {
+
+    var sto = new Fridge.StringStorage ();
+    print ("\n" + "Location: " + sto.storage_path + "\n");
+
+    switch (args[1]) {
+      case "load": print (sto.content);break;
+      case "save": sto.content = args[2];break;
+      default: ;break;
+    }
+
+    return 0;
+  }

demo/meson.build

@@ -0,0 +1,11 @@
+
+  executable(
+      'libfridge-demo',
+      'demo.vala',
+
+      dependencies: [
+          dependency ('libfridge-0.1')
+      ],
+
+      install: true,
+  )