Skip to content

Commit 9ae178d

Browse files
committed
Update Zinc documentation
1 parent 67881e7 commit 9ae178d

File tree

1 file changed

+16
-77
lines changed

1 file changed

+16
-77
lines changed

frameworks/Zig/zinc/README.md

Lines changed: 16 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,26 @@
1-
# Congratulations!
1+
# [Zinc](https://zinc.zon.dev) web framework
22

3-
You have successfully built a new test in the suite!
3+
## Description
44

5-
There are some remaining tasks to do before you are ready to open a pull request, however.
5+
Zinc is a web framework written in pure Zig with a focus on high performance, usability, security, and extensibility.
66

7-
## Next Steps
7+
* [Documentation](https://zinc.zon.dev/)
88

9-
1. Gather your source code.
10-
11-
You will need to ensure that your source code is beneath this directory. The most common solution is to include a `src` directory and place your source code there.
12-
13-
2. Edit `benchmark_config.json`
14-
15-
You will need alter `benchmark_config.json` to have the appropriate end-points and port specified.
16-
17-
3. Create `zinc.dockerfile`
18-
19-
This is the dockerfile that is built into a docker image and run when a benchmark test is run. Specifically, this file tells the suite how to build and start your test application.
20-
21-
You can create multiple implementations and they will all conform to `[name in benchmark_config.json].dockerfile`. For example, the `default` implementation in `benchmark_config.json` will be `zinc.dockerfile`, but if you wanted to make another implementation that did only the database tests for MySQL, you could make `zinc-mysql.dockerfile` and have an entry in your `benchmark_config.json` for `zinc-mysql`.
22-
23-
4. Test your application
24-
25-
$ tfb --mode verify --test zinc
26-
27-
This will run the suite in `verify` mode for your test. This means that no benchmarks will be captured and we will test that we can hit your implementation end-points specified by `benchmark_config.json` and that the response is correct.
28-
29-
Once you are able to successfully run your test through our suite in this way **and** your test passes our validation, you may move on to the next step.
30-
31-
5. Add your test to `.github/workflows/build.yml`
32-
33-
Edit `.github/workflows/build.yml` to ensure that Github Actions will automatically run our verification tests against your new test. This file is kept in alphabetical order, so find where `TESTDIR=Zig/zinc` should be inserted under `env > matrix` and put it there.
34-
35-
6. Fix this `README.md` and open a pull request
36-
37-
Starting on line 49 is your actual `README.md` that will sit with your test implementation. Update all the dummy values to their correct values so that when people visit your test in our Github repository, they will be greated with information on how your test implementation works and where to look for useful source code.
38-
39-
After you have the real `README.md` file in place, delete everything above line 59 and you are ready to open a pull request.
40-
41-
Thanks and Cheers!
42-
43-
44-
45-
46-
47-
48-
49-
# Zinc Benchmarking Test
50-
51-
### Test Type Implementation Source Code
52-
53-
* [JSON](Relative/Path/To/Your/Source/File)
54-
* [PLAINTEXT](Relative/Path/To/Your/Source/File)
55-
* [DB](Relative/Path/To/Your/Source/File)
56-
* [QUERY](Relative/Path/To/Your/Source/File)
57-
* [CACHED QUERY](Relative/Path/To/Your/Source/File)
58-
* [UPDATE](Relative/Path/To/Your/Source/File)
59-
* [FORTUNES](Relative/Path/To/Your/Source/File)
9+
### Some features are:
10+
- **Fast**
11+
- **Custom allocator**
12+
- **Multithreading**
13+
- **Middleware**
14+
- **Routes grouping**
15+
- **Rendering built-in**
16+
- **Extensible**
17+
- **Suite of unit tests**
18+
- **Usability**
6019

6120
## Important Libraries
6221
The tests were run with:
63-
* [Software](https://www.example1.com/)
64-
* [Example](http://www.example2.com/)
22+
* [Software](https://zinc.zon.dev/)
23+
* [Example](https://github.com/zon-dev/zinc-examples)
6524

6625
## Test URLs
6726
### JSON
@@ -71,23 +30,3 @@ http://localhost:8080/json
7130
### PLAINTEXT
7231

7332
http://localhost:8080/plaintext
74-
75-
### DB
76-
77-
http://localhost:8080/db
78-
79-
### QUERY
80-
81-
http://localhost:8080/query?queries=
82-
83-
### CACHED QUERY
84-
85-
http://localhost:8080/cached_query?queries=
86-
87-
### UPDATE
88-
89-
http://localhost:8080/update?queries=
90-
91-
### FORTUNES
92-
93-
http://localhost:8080/fortunes

0 commit comments

Comments
 (0)