Skip to content

Update README for the recently released features#367

Merged
pulorsok merged 14 commits into
ev-flow:masterfrom
haeter525:fix/update_README
Jul 6, 2022
Merged

Update README for the recently released features#367
pulorsok merged 14 commits into
ev-flow:masterfrom
haeter525:fix/update_README

Conversation

@haeter525

@haeter525 haeter525 commented Jul 4, 2022

Copy link
Copy Markdown
Member

Description
Close #366.
This PR aims to do the following improvements on README.

1 - Clean up outdated information

  • Change the link of social media to Quark's Twitter account. (ac44d10)
  • Fix the wrong commands in the Detail Report section. (4b648e3)
  • Add an introduction for Detection Rules Viewer. (2339018)

2 - Simplify the content

  • Move the screenshots into the collapsible sections. (54cc4e1)
  • Simplify the description of getting the latest rules. (f29a322)

3 - Adjusting the layout

  • Add an overview of all the features. (24e2838)
  • Rearrange the introduction of each report according to the above overview. (dba524e)
  • Move the introductions of the features downward. (5c2a664)

Test Plans
All commands in README have been tested.

@haeter525 haeter525 force-pushed the fix/update_README branch from cff449f to 420f586 Compare July 5, 2022 09:35
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Merging #367 (bef1fb2) into master (be21897) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #367   +/-   ##
=======================================
  Coverage   74.21%   74.21%           
=======================================
  Files          52       52           
  Lines        3933     3933           
=======================================
  Hits         2919     2919           
  Misses       1014     1014           
Flag Coverage Δ
unittests 74.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 be21897...bef1fb2. Read the comment docs.

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.

Update README for the recently released features.

3 participants