From f93ac68ae29c0b6a2ef8dbd55463a3c460a3cea3 Mon Sep 17 00:00:00 2001
From: CncAnon <50481-cncanon@users.noreply.gitgud.io>
Date: Thu, 31 Aug 2023 00:58:09 +0000
Subject: [PATCH] Update README.md

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c1c4d08..65b20f4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
-# SG-proxy
+# sg-proxy - free Claude
 
-For instructions see https://rentry.org/sg_proxy
\ No newline at end of file
+Requirements: Node, NPM.
+
+1) Create a SourceGraph account (no phone required, just normal email/password).
+2) Go to https://sourcegraph.com/, click on your profile icon in upper-right, then Settings, then go to Account->Access tokens, and generate a new token.
+3) Clone/download https://gitgud.io/cncanon/sg-proxy/.
+4) Open `.env` in the proxy folder and put your token there, so it looks like `API_TOKEN="sgp_mytoken"`
+5) Run `start.sh` if you're on *nix, otherwise run `start.bat`. If you want to run manually, just `npm install --no-audit` and then `node main.js`. 
+6) Change completion to Claude in ST, set any API key, then set the proxy URL as `http://localhost:3000/v1` and set any password.
+
+If you want to use it remotely, you can use any tunneling service e.g. ngrok or cloudflared, for example just `cloudflared tunnel --url http://localhost:3000` is enough to tunnel the proxy through Cloudflare, then you can access it via the given URL with the /v1 suffix.
+
+Enjoy.
+
+### Updates
+- 30/08/2023 - Fixed two reported issues - [broken streaming for multi-byte characters (non-English text)](https://gitgud.io/cncanon/sg-proxy/-/issues/2) and [misleading error for when there's an error](https://gitgud.io/cncanon/sg-proxy/-/issues/1). Now you should be able to stream non-English text (Japanese, Russian, etc) and, if sg-proxy catches an error, see the note about it in the message instead of ST never finishing the request. 
+
+### Notes
+- Only tested with the model `claude-2`, older ones might work if their API allows to, maybe not.
+- The upper limit on the context size is unknown, please test. The initial value was at ~20K, but that was due to a (fixed) bug in the proxy. Some people have reported being able to use 50-80K context without issues.
+- The API has a daily rate-limit for requests. Some people have reported it as being at 100 requests, some - 50, but it might differ per-account. If you get a 429 error in console, just create a new account.
+
+Contact: cncanon1@proton.me.