Closed ioj closed 7 years ago
I improved it a bit, but it lacks a thorough description what namescore actually is, its purpose, what's AlphaSOC, etc. Ideally, README should be a great landing page which leaves no unanswered questions between cloning the repo and successfully running namescore.
Some examples of good readme files in my opinion:
I need:
/home/phob0s
as that seems unprofessional@chrisforce1 please branch off develop to your own branch (i.e. chris/readme
) and make all necessary changes there. README in develop is already updated (compared to master).
If you can, please also make a vagrant instance with ubuntu or debian and follow the installation steps. Then you'll know how the registration flow looks like and you'll be able to create relevant shell snippets.
Oh, also regarding (3) -- the new namescore can't parse logs, it works like DDI Guard Agent now, so
sniffing only and (5) It's already gone in develop
branch.
Take a look. I assume the govendor sync
line is obsolete?
Please adjust and I think we're good to make this public, thanks.
Please take a look and let's prepare this README for public release, thanks.
Update README with a more comprehensive installation guide.