From b9234200f938c80fad0ff7ea141b193946c0feaa Mon Sep 17 00:00:00 2001 From: k4hvd1 Date: Tue, 28 Sep 2021 16:53:16 +0200 Subject: [PATCH] Updated README.md with new config approach --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de8287e..e1573ae 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,23 @@ Gitea-VSCode is an Visual Studio Code extension that allows you to manage (curre Go to your settings, and find the `Gitea` section, and fill out the details. -Please make sure to not to make your authtoken public, as it can be used to act on your behalf. -Also do not push the .vscode folder to your repository and doublecheck this part. It contains your gitea server instance key. +Please make sure not to make your authtoken public, as it can be used to act on your behalf. +Keep instance key `"gitea.token"` in [user settings](https://vscode.readthedocs.io/en/latest/getstarted/settings/) other section keys keep in `.vscode/settings.json`. +Otherwise do not push the .vscode folder to your repository and doublecheck this part. It contains your gitea server instance key. + +### Config example + +- go to `https://%YOUR_GITEA_SERVER/user/settings/applications` and `Generate Token` +- fill `,"gitea.token": "%YOUR_KEY%"` in VS code user settings in following locations: + - Win %APPDATA%\Code\User\settings.json + - Mac $HOME/Library/Application Support/Code/User/settings.json + - Linux $HOME/.config/Code/User/settings.json +- fill in `.vscode/settings.json` +``` + , "gitea.instanceURL": "%YOUR_GITEA_SERVER%" + , "gitea.owner": "%OWNER%" + , "gitea.repo": "%REPO_NAME%" +``` ### The following details are needed