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

Make readme more readable for freshman #675

Merged
merged 18 commits into from
Oct 25, 2019
Merged

Make readme more readable for freshman #675

merged 18 commits into from
Oct 25, 2019

Conversation

iwasherefirst2
Copy link
Collaborator

This is a proposal how to change the structure of the readme to make it more readable for freshman (you may take a look at https://github.com/iwasherefirst2/laravel-localization/tree/changeReadmeALot).

I came up with this after closing a lot of issues and realizing there were 3 mayor problems

  1. People did not know what this package offers and what not
  2. People were confused how and when to use middleware
  3. People did not localize POST urls.

Proposed changes:

  • Add list of features that the package offers as a summary on top
  • Move Collaborators to bottom for readability
  • Move installation of outdated Laravel 5.4< on extra Additions.md page
  • Move Config/Middleware setup into installation section
  • Name 8 config settings in readme (when you look first time into the config file, you think its more complicated as it is).
  • Create extra secction for redirecting middleware
  • Clean up dead links of ToC
  • Cleanup the helpers (The PHPDocs should not be in the readme.md file)
  • Add two recommendations in usage section:
      1. Recommend to use redirecting middleware
      1. Recommend to localoze urls.

@mcamara
Copy link
Owner

mcamara commented Oct 25, 2019

The changes look good, I'll merge it 😄

@mcamara mcamara merged commit 460292b into mcamara:master Oct 25, 2019
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