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

Update repo README with new wording, locust example, screenshots #1532

Merged
merged 1 commit into from
Aug 20, 2020
Merged

Update repo README with new wording, locust example, screenshots #1532

merged 1 commit into from
Aug 20, 2020

Conversation

max-rocket-internet
Copy link
Contributor

  • Copy latest wording from docs
  • Add very simple example that shows clearly how a locust file is written
  • Add some screen shots from the UI
  • Format features correctly using #### instead of bold bullet points
  • Use consistent bullet point syntax
  • Remove unnecessary HTML
  • Add github links for authors
  • Move Links to the end as these are boring
  • Remove Documentation section as this is already in the Links section

And generally make it nice and clean
add images
@codecov
Copy link

codecov bot commented Aug 20, 2020

Codecov Report

Merging #1532 into master will decrease coverage by 0.46%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1532      +/-   ##
==========================================
- Coverage   82.38%   81.91%   -0.47%     
==========================================
  Files          28       28              
  Lines        2560     2560              
  Branches      388      388              
==========================================
- Hits         2109     2097      -12     
- Misses        355      365      +10     
- Partials       96       98       +2     
Impacted Files Coverage Δ
locust/clients.py 90.19% <0.00%> (-4.91%) ⬇️
locust/runners.py 83.23% <0.00%> (-1.34%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9eae52d...eb146ea. Read the comment docs.

@cyberw
Copy link
Collaborator

cyberw commented Aug 20, 2020

Thx!

@cyberw cyberw merged commit bda00f6 into locustio:master Aug 20, 2020
@max-rocket-internet max-rocket-internet deleted the nice_readme branch August 20, 2020 13:14
@cyberw
Copy link
Collaborator

cyberw commented Aug 20, 2020

Huh. The images are broken on the pypi page: https://pypi.org/project/locust/

Perhaps we need to use absolute URLs to github (unless there is some other solution)

@max-rocket-internet
Copy link
Contributor Author

OK I can make the image links use raw links to this repo

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