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

Rewrite readme #578

Merged
merged 4 commits into from
Dec 19, 2024
Merged

Rewrite readme #578

merged 4 commits into from
Dec 19, 2024

Conversation

ErikPelli
Copy link
Collaborator

Rewrite project readme to include new updates and make it more appropriate.
This PR also updates x/net dependency.

@ErikPelli
Copy link
Collaborator Author

ErikPelli commented Dec 19, 2024

@elazarl what do you think about this new readme? Can it be merged?
Here there is a link with the formatted preview so you can check it better: https://github.com/elazarl/goproxy/blob/rewrite-readme/README.md

@elazarl
Copy link
Owner

elazarl commented Dec 19, 2024

@ErikPelli truly amazing. IMHO italics emphasizes better than code.

Let's merge!

@elazarl elazarl merged commit 0cbc932 into master Dec 19, 2024
1 check passed
@ErikPelli
Copy link
Collaborator Author

Do you prefer italic style? I could change it if you want

@elazarl
Copy link
Owner

elazarl commented Dec 19, 2024

Do you prefer italic style? I could change it if you want

Let me explain

The proxy itself is simply a net/http handler,

Here it's great to have net/http as code, as this is a piece of code.

The target of this project is to offer an optimized proxy server,

Here optimized is more appropriate, as it is an English word, and not a piece of code that could appear in the source.

Does that make sense?

@ErikPelli
Copy link
Collaborator Author

Does that make sense?

Yes, do you want to make a PR to fix the style where you think this is appropriate or should I change it, if you haven't any time available?

@ErikPelli ErikPelli deleted the rewrite-readme branch December 19, 2024 15:51
@elazarl
Copy link
Owner

elazarl commented Dec 19, 2024

NM, that's a cool style, and let's keep it as it is for the time being. I like it when your fingerprints are felt over the project.

I'll take the oppurtunity to thank you for the tremndous work and effort you invest in the project. It is felt and is hearwarming.

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