docs: Create comprehensive README.md #44
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replaces the placeholder README with a full document covering all major features, configuration, and usage for external developers.
amir-khassaia
approved these changes
Aug 19, 2025
hiroxy
reviewed
Aug 19, 2025
README.md
Outdated
| * **Scheduled Tasks**: Run recurring tasks using powerful cron syntax. | ||
| * **Ad-Hoc Commands**: Expose custom command-line commands in a consistent way that can be triggered from the command line. | ||
| * **Simple Configuration**: All behaviour is controlled by a single, comprehensive JSON configuration file. | ||
| * **Logging**: Built-in centralised logging for both Silver and your application's output. Log buffing, flushing and rotation is automatically handled. |
This commit updates README.md to remove the outdated reference of using SHA1 for checksums. While we'll maintain backwards compatibility for existing integrations, we want to align our documentation with modern security best practices and nnot hint to its use.
tinhtruong
reviewed
Aug 20, 2025
|
|
||
| Typical usages might include: | ||
| * wrapping a single Java web application | ||
| * hosting a set of Go microservices |
Contributor
Author
There was a problem hiding this comment.
I'll leave this. It's what i'm attending as it's what we're using it for.
tinhtruong
reviewed
Aug 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fleshes out the README.md from a placeholder to a complete guide. It covers all the key areas to help someone get started with Silver.
What's new: