From 38bc1f056497c583deea4131236b622e14ba9439 Mon Sep 17 00:00:00 2001 From: Vincent Le Quec Date: Tue, 22 Jul 2025 10:41:50 +0200 Subject: [PATCH] chore: Update `.gitignore`, documentation, and README updates - Expanded `.gitignore` with IDE/editor-specific files - Improved instructions in `CONTRIBUTING.md` - Minor phrasing tweak in `README.md` for better clarity --- .gitignore | 16 +++++++++++++++- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- 3 files changed, 19 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 458007f..6ddd9fe 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,15 @@ -go.work.sum \ No newline at end of file +go.work.sum + +# IDEs and editors +.idea +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3231740..335c48a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ # Dev with Docker & VSCode ```bash -git clone # git clone project +git clone # or gh repo clone Intrinsec/s3proxy cd s3proxy docker run --rm -p 4433:4433 -v $PWD:/app -it golang:1.23 bash # In VSCode, use "Attach to Running Container..." option => select golang container => open /app folder go run s3proxy/cmd/main.go --no-tls -``` \ No newline at end of file +``` diff --git a/README.md b/README.md index 8c95de6..4eaf2ea 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## Features - **Automatic encryption** for all PUT requests before storage on S3 - **Transparent decryption** of GET requests when retrieving data from S3 -- **Easy setup**: simply run the proxy and direct your HTTP requests through it. +- **Easy setup**: run the proxy and direct your HTTP requests through it. ## Usage (Docker) @@ -21,4 +21,4 @@ helm ugprade --install s3proxy oci://ghcr.io/intrinsec/s3proxy/charts/s3proxy ## Contribution -[CONTRIBUTING](CONTRIBUTING.md) \ No newline at end of file +[CONTRIBUTING](CONTRIBUTING.md)