writehat icon indicating copy to clipboard operation
writehat copied to clipboard

Published 20 hours ago • verified publisher icon blacklanternsecurity

Add documentation to the README file

Open Inf0Junki3 opened this issue 2 years ago • 5 comments

Greetings,

Long time follower, first time contributor. Thought I would add a bit of minor documentation destined to help WriteHat newbies like me:

  • How to clear data
  • How to make use of markdown placeholders.

Given that these are not code changes, thought I would make the PR against master - but please let me know if you would prefer that I make the PR against a dev branch.

Hope this is useful!

Inf0Junki3 avatar Feb 24 '23 15:02 Inf0Junki3

Trying to raise awareness for this request

d4r14h avatar Jun 14 '23 22:06 d4r14h

Just to add to this, it should be mentioned in the README that there is a button which has a list of the markdown placeholders that can be used. image

thejohnbrown avatar Jun 15 '23 08:06 thejohnbrown

Ya, If you could change the pull request to be against the github-dev branch, that would probably be better. The github-dev branch is generally more up to date and actually has a fair number of additions compared to the master branch.

TMDeal avatar Jun 21 '23 14:06 TMDeal

@TMDeal Unrelated to this PR, is the github-dev branch stable enough to run in production?

thejohnbrown avatar Jun 27 '23 08:06 thejohnbrown

@thejohnbrown, as of right now, the github-dev branch should be good to use for production. Given that it is being updated semi-frequently, I would recommend always being cautious when new changes are merged into it just to be on the safe side

TMDeal avatar Jun 29 '23 13:06 TMDeal