From 25b4047743f07f88b9835242a608bf8bdf3d817b Mon Sep 17 00:00:00 2001 From: retoor Date: Mon, 23 Dec 2024 18:09:16 +0100 Subject: [PATCH] Review first part. --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 486dcbc..aedf764 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# SwiftDevRantSDK \ No newline at end of file +# SwiftDevRantSDK + +All the things we do for our fellow ranters! This is a review of [SwiftDevRantSDK](https://github.com/WilhelmOks/SwiftDevRantSDK/tree/main). It's a directory that startswith a . because I normally don't commit it. + +## You want a review like this too? +If you want to have a file reviewed / checked for bugs with this beautiful system just execute code below with python (no libraries required, xmlrpc client of your prefered language is also fine). It has support any syntax and will auto resolve the syntax type.: +```python +from xmlrpc.client import ServerProxy +client = ServerProxy("https://api.retoor.molodetz.nl/rpc") +with f.open("your-file.swift", "r") as f: + content = f.read() + pinrt(client.review(content)) +``` +It's fine to iterate trough your project and review one by one, but preferrably not concurrent. +My server supports it, but the LLM only limited I can imagine. It takes 15-30 seconds review per file. +You can let your file auto refactor with best practices using client.refactor([source_data]) but it will add my name above it and a MIT license. +It will only do some additions and some formatting. Not fuck up your code. + +Using my software comes with unlimited warranty. I do take full responsibility for any damage the software makes. Let's find out what that's worth. + +## Review summary. +This README file is only a summary of the detailed reviews in the [Reviews](.reviews/) directory. The summary could be bigger, but I limited it to something you would actually read. Every file is reviewed in detail and contains metadata like grade, size and line count. + +