updated README and added CI

Author: keltonhalbert

.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [main]
+
+  pull_request:
+    branches: [main]
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up LLVM and Clang
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y lld llvm llvm-dev clang
+
+      - name: Set up Zig
+        uses: mlugg/setup-zig@v1
+
+      - name: Run `build`
+        run: zig build

README.md

@@ -1,2 +1,46 @@
-# Zig-ZFP: A Zig Build Process for the ZFP Compression Library
-This is intended to be a simple build wrapper around the [ZFP C compression library](https://github.com/LLNL/zfp) for Zig.
+# zfp-zig: zfp packaged for the Zig programming language
+This is the [ZFP C compression library](https://github.com/LLNL/zfp) for the [Zig](https://ziglang.org/) programming language.
+
+# How do I include it in my Zig program?
+If you are starting a new package: 
+```bash
+
+mkdir my_project; cd my_project
+zig init
+## add the package to 'build.zig.zon'
+zig fetch --save=zfp git+https://github.com/keltonhalbert/zfp.git
+```
+This will add the zig C library as a dependency to your project. 
+Next, if you are linking it to a library or executable, add the following to **build.zig**:
+```Zig
+pub fn build(b: *std.Build) !void {
+    const target = b.standardTargetOptions(.{});
+
+    const optimize = b.standardOptimizeOption(.{});
+
+    const zfp_dep = b.dependency("zfp", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    // if you are linking it to a library...
+    const lib_mod = b.createModule(.{
+        .root_source_file = b.path("src/root.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    lib_mod.linkLibrary(zfp_dep.artifact("zfp"));
+        
+    // or, if you are linking it to an executable...
+    const exe_mod = b.createModule(.{
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    exe_mod.linkLibrary(zfp_dep.artifact("zfp"));
+}
+```
+# Requirements
+The target version of Zig is ```0.14```. It may work with earlier versions, but has not been tested.