polish readme

Author: jiacai2050

.gitignore

@@ -16,7 +16,6 @@ docgen_tmp/
 .vagrant
 Vagrantfile
 zig-linux*
-docs
 libroot*
 .DS_Store
 *.o

README.org

@@ -1,16 +1,17 @@
 #+TITLE: zig-curl
 #+DATE: 2023-09-16T23:16:15+0800
-#+LASTMOD: 2025-10-02T10:13:24+0800
+#+LASTMOD: 2025-10-03T12:30:00+0800
 #+OPTIONS: toc:nil num:nil
 #+STARTUP: content
 
 [[https://img.shields.io/badge/zig%20version-0.15.1-blue.svg]]
-[[https://img.shields.io/badge/zig%20version-master-blue.svg]]
 [[https://github.com/jiacai2050/zig-curl/actions/workflows/CI.yml][https://github.com/jiacai2050/zig-curl/actions/workflows/CI.yml/badge.svg]]
 [[https://ci.codeberg.org/repos/13257][https://ci.codeberg.org/api/badges/13257/status.svg]]
 
 Zig bindings for [[https://curl.haxx.se/libcurl/][libcurl]], a free and easy-to-use client-side URL transfer library.
 
+[[file:docs/logo.svg]]
+
 The vendored libraries consist of:
 | Library | Version |
 |---------+---------|
@@ -26,11 +27,7 @@ cat examples/basic.zig
 #+RESULTS:
 #+begin_src zig
 const std = @import("std");
-const println = @import("util.zig").println;
-const mem = std.mem;
-const Allocator = mem.Allocator;
 const curl = @import("curl");
-const Easy = curl.Easy;
 
 pub fn main() !void {
     var gpa: std.heap.DebugAllocator(.{}) = .init;
@@ -39,38 +36,35 @@ pub fn main() !void {
 
     const ca_bundle = try curl.allocCABundle(allocator);
     defer ca_bundle.deinit();
-    const easy = try Easy.init(.{
+    const easy = try curl.Easy.init(.{
         .ca_bundle = ca_bundle,
     });
     defer easy.deinit();
+
     {
-        println("GET without write context");
+        std.debug.print("GET without body\n", .{});
         const resp = try easy.fetch("https://httpbin.org/anything", .{});
-
         std.debug.print("Status code: {d}\n", .{resp.status_code});
     }
 
     {
-        println("GET with fixed buffer");
+        std.debug.print("\nGET with fixed buffer as body\n", .{});
         var buffer: [1024]u8 = undefined;
         var writer = std.Io.Writer.fixed(&buffer);
-        const resp = try easy.fetch("https://httpbin.org/anything", .{
-            .writer = &writer,
-        });
-        std.debug.print("Status code: {d}\nBody: {s}\n", .{
-            resp.status_code,
-            writer.buffered(),
-        });
+        const resp = try easy.fetch("https://httpbin.org/anything", .{ .writer = &writer });
+        std.debug.print("Status code: {d}\nBody: {s}\n", .{ resp.status_code, writer.buffered() });
     }
 }
 #+end_src
 
+Check [[file:examples]] for more examples.
 
-See [[file:examples/basic.zig]], [[file:examples/advanced.zig]] for more usage.
+* Documentation
+See https://jiacai2050.github.io/zig-curl/
 
 * Installation
 #+begin_src bash
-zig fetch --save=curl  https://github.com/jiacai2050/zig-curl/archive/refs/tags/${TAG}.zip
+zig fetch --save=curl https://github.com/jiacai2050/zig-curl/archive/refs/tags/${TAG}.zip
 #+end_src
 
 The latest tag can be found on [[https://github.com/jiacai2050/zig-curl/releases/][release page]].

docs/logo.svg

@@ -1,9 +1,5 @@
 const std = @import("std");
-const println = @import("util.zig").println;
-const mem = std.mem;
-const Allocator = mem.Allocator;
 const curl = @import("curl");
-const Easy = curl.Easy;
 
 pub fn main() !void {
     var gpa: std.heap.DebugAllocator(.{}) = .init;
@@ -12,27 +8,22 @@ pub fn main() !void {
 
     const ca_bundle = try curl.allocCABundle(allocator);
     defer ca_bundle.deinit();
-    const easy = try Easy.init(.{
+    const easy = try curl.Easy.init(.{
         .ca_bundle = ca_bundle,
     });
     defer easy.deinit();
+
     {
-        println("GET without write context");
+        std.debug.print("GET without body\n", .{});
         const resp = try easy.fetch("https://httpbin.org/anything", .{});
-
         std.debug.print("Status code: {d}\n", .{resp.status_code});
     }
 
     {
-        println("GET with fixed buffer");
+        std.debug.print("\nGET with fixed buffer as body\n", .{});
         var buffer: [1024]u8 = undefined;
         var writer = std.Io.Writer.fixed(&buffer);
-        const resp = try easy.fetch("https://httpbin.org/anything", .{
-            .writer = &writer,
-        });
-        std.debug.print("Status code: {d}\nBody: {s}\n", .{
-            resp.status_code,
-            writer.buffered(),
-        });
+        const resp = try easy.fetch("https://httpbin.org/anything", .{ .writer = &writer });
+        std.debug.print("Status code: {d}\nBody: {s}\n", .{ resp.status_code, writer.buffered() });
     }
 }