From c787f4476f1901de93898f35cb50553addd08f4c Mon Sep 17 00:00:00 2001 From: EntireTwix Date: Tue, 20 Jul 2021 00:31:05 -0700 Subject: [PATCH] :books::construction: --- docs/connected_services/existing_services.md | 2 +- docs/features/implementation.md | 10 +++++----- docs/features/user_side.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/connected_services/existing_services.md b/docs/connected_services/existing_services.md index 765cea7..d8256a8 100644 --- a/docs/connected_services/existing_services.md +++ b/docs/connected_services/existing_services.md @@ -3,7 +3,7 @@ ## General | name | v1 | | :--------------------------------------------------------------- | :----------------------: | -| [Expand's Frontend](https://github.com/Expand-sys/ccashfrontend) | :heavy_multiplication_x: | +| [Expand's Frontend](https://github.com/Expand-sys/ccashfrontend) | :heavy_check_mark: | | [Expand's Discord Bot](https://github.com/Expand-sys/ccashbot) | :heavy_multiplication_x: | | [Doggo's CCash CLI](https://github.com/FearlessDoggo21/CCashCMD) | :heavy_multiplication_x: | diff --git a/docs/features/implementation.md b/docs/features/implementation.md index 9619253..7890e9d 100644 --- a/docs/features/implementation.md +++ b/docs/features/implementation.md @@ -11,10 +11,10 @@ this parallel hashmap implementation is the basis of CCash, its where all the us ![image](https://raw.githubusercontent.com/greg7mdp/parallel-hashmap/master/html/img/lock_various_sizes.PNG) ## [xxHash](https://github.com/Cyan4973/xxHash) xxhash is used for both hashing of passwords for storage aswell as the usernames for indexing the phmap, its speed is ridiculous at faster then `memcpy` rates of Gb/s. -| Hash Name | Width | Bandwidth (GB/s) | Small Data Velocity | Quality | Comment | -| --------------------- | ----- | ---------------- | ------------------- | ------- | --------------- | -| __XXH3__ (SSE2) | 64 | 31.5 GB/s | 133.1 | 10 | -| _RAM sequential read_ | N/A | 28.0 GB/s | N/A | N/A | _for reference_ | +| Hash Name | Width | Bandwidth (GB/s) | +| --------------------- | ----- | ---------------- | +| __XXH3__ (SSE2) | 64 | 31.5 GB/s | +| _RAM sequential read_ | N/A | 28.0 GB/s | ## [Base64](https://github.com/aklomp/base64) base64 decoding is required for Basic Auth so I used this clean and fast solution which uses SIMD. ![image](https://github.com/aklomp/base64/blob/master/base64-benchmarks.png) @@ -44,4 +44,4 @@ saving is done using FBE, this slightly reduces file size compared to JSON and i ## Multi-threading support considering phmap and drogon both massively benefit from being multi-threaded it seemed obvious that the entire program should be, this is enabled by default and manually settable at `MULTI_THREADED`. ## Backwards Compatible API -versioning is implemented by the endpoints path, for example `/v1`. Breaking changes will ideally be sparse and backwards compatability will be maintained, for example ideally API `v3` instance can still run `v1` endpoints. +versioning is implemented by the endpoints path, for example `api/v1/`. Breaking changes will ideally be sparse and backwards compatability will be maintained, for example ideally API `v3` instance can still run `v1` endpoints. diff --git a/docs/features/user_side.md b/docs/features/user_side.md index 5a829f4..0086af4 100644 --- a/docs/features/user_side.md +++ b/docs/features/user_side.md @@ -7,7 +7,7 @@ #### Connected Services as explained in earlier docs a ecosystem of connected services allows you many ways to utilize CCash. #### APIs -for devs who wanna make more connected services existing APIs exist in multiple lanaguages enabling faster development/maintenance. +for devs who wanna make more connected services, existing APIs exist in multiple lanaguages enabling faster development/maintenance. #### External its game indepedent meaning you dont have to be in-game to use it. ## Security