Skip to content

Commit a79e541

Browse files
Added Features and better build info to README
1 parent 58873c8 commit a79e541

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@
55

66
A web-based GUI for your AWS or LocalStack environment.
77

8+
## Features
9+
10+
Contributions and feature requests are welcome!
11+
12+
- **AWS S3**
13+
- Create, view and delete buckets
14+
- View, delete, upload and download objects
15+
16+
- **AWS SQS**
17+
- Create, view and delete queues
18+
- Send, receive and peek messages
19+
- Import Protobuf definitions and send Protobuf-formatted messages
20+
21+
Also see planned features: #1
22+
23+
## Download
24+
25+
Download precompiled executables from [Releases](https://github.com/Visual-Vincent/GuiStack/releases), or pull the latest [Docker image](https://hub.docker.com/r/visualvincent/guistack).
26+
827
## System requirements
928
- ASP.NET Core Runtime for .NET 6.0 or newer ([Download](https://dotnet.microsoft.com/en-us/download/dotnet))
1029
- Any operating system supported by the above runtime
@@ -64,6 +83,9 @@ docker run -p 5000:80 \
6483
## Building
6584
Requires:
6685
- .NET 6.0 SDK or newer ([Download](https://dotnet.microsoft.com/en-us/download/dotnet))
86+
- Git Bash (if building on Windows) ([Download](https://gitforwindows.org/))
6787

6888
Optional:
6989
- Visual Studio 2022
90+
91+
To build GuiStack, simply execute one of the `build-*.sh` scripts for the platform you wish to build for, located in the root of this repository.

0 commit comments

Comments
 (0)