Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #5024

Closed
wants to merge 1 commit into from
Closed

Updated README.md #5024

wants to merge 1 commit into from

Conversation

rushi-k12
Copy link
Contributor

Added more relevant information and improvised the readme.md file to help make it more useful and informative to the Open-Source Community.


## Usage
See the [vaultwarden wiki](https://github.com/dani-garcia/vaultwarden/wiki) for more information on how to configure and run the vaultwarden server.

## Get in touch
To ask a question, offer suggestions or new features or to get help configuring or installing the software, please use [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [the forum](https://vaultwarden.discourse.group/).
To ask a question and or offer suggestions or new features or to get help configuring or installing the software, please use [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [the forum](https://vaultwarden.discourse.group/).
Copy link

@Skwangles Skwangles Oct 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To ask a question, offer suggestions or new features, or to.... I think would be better grammar.
and<space>or is incorrect, because it's a list of clauses '1, 2, or 3...'

@@ -46,13 +46,13 @@ This will preserve any persistent data under /vw-data/, you can adapt the path t

This can be configured in [vaultwarden directly](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)).

If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above).
If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate any self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above).
Copy link

@Skwangles Skwangles Oct 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think any detracts from the sentence. The sentence makes sense without it. I've been taught with writing that the less wordier your sentences the better!

BlackDex added a commit to BlackDex/vaultwarden that referenced this pull request Nov 1, 2024
Updating the Readme to be more modern and more clear.
Added and moved several shields/badges and changed some default colors to have a better contrast.
Added a Disclaimer section.

Closes dani-garcia#4901
Closes dani-garcia#4930
Closes dani-garcia#4931
Closes dani-garcia#5024

Co-authored-by: ipitio <[email protected]>
Co-authored-by: Robert Schütz <[email protected]>
Co-authored-by: Yonas Yanfa <[email protected]>
Co-authored-by: KUSUMA RUSHIKESH <[email protected]>
@BlackDex BlackDex mentioned this pull request Nov 1, 2024
BlackDex added a commit to BlackDex/vaultwarden that referenced this pull request Nov 1, 2024
Updating the Readme to be more modern and more clear.
Added and moved several shields/badges and changed some default colors to have a better contrast.
Added a Disclaimer section.

Closes dani-garcia#4901
Closes dani-garcia#4930
Closes dani-garcia#4931
Closes dani-garcia#5024

Co-authored-by: ipitio <[email protected]>
Co-authored-by: Robert Schütz <[email protected]>
Co-authored-by: Yonas Yanfa <[email protected]>
Co-authored-by: KUSUMA RUSHIKESH <[email protected]>
BlackDex added a commit to BlackDex/vaultwarden that referenced this pull request Nov 1, 2024
Updating the Readme to be more modern and more clear.
Added and moved several shields/badges and changed some default colors to have a better contrast.
Added a Disclaimer section.

Closes dani-garcia#4901
Closes dani-garcia#4930
Closes dani-garcia#4931
Closes dani-garcia#5024

Co-authored-by: ipitio <[email protected]>
Co-authored-by: Robert Schütz <[email protected]>
Co-authored-by: Yonas Yanfa <[email protected]>
Co-authored-by: KUSUMA RUSHIKESH <[email protected]>
BlackDex added a commit to BlackDex/vaultwarden that referenced this pull request Nov 1, 2024
Updating the Readme to be more modern and more clear.
Added and moved several shields/badges and changed some default colors to have a better contrast.
Added a Disclaimer section.

Closes dani-garcia#4901
Closes dani-garcia#4930
Closes dani-garcia#4931
Closes dani-garcia#5024

Co-authored-by: ipitio <[email protected]>
Co-authored-by: Robert Schütz <[email protected]>
Co-authored-by: Yonas Yanfa <[email protected]>
Co-authored-by: KUSUMA RUSHIKESH <[email protected]>
BlackDex added a commit to BlackDex/vaultwarden that referenced this pull request Nov 2, 2024
Updating the Readme to be more modern and more clear.
Added and moved several shields/badges and changed some default colors to have a better contrast.
Added a Disclaimer section.

Closes dani-garcia#4901
Closes dani-garcia#4930
Closes dani-garcia#4931
Closes dani-garcia#5024

Co-authored-by: ipitio <[email protected]>
Co-authored-by: Robert Schütz <[email protected]>
Co-authored-by: Yonas Yanfa <[email protected]>
Co-authored-by: KUSUMA RUSHIKESH <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants