From ef4653fd1084480143c70480e73ffc9e8da97866 Mon Sep 17 00:00:00 2001 From: "Joshua Hallstrom (hallstromj)" Date: Thu, 26 Nov 2020 15:14:56 +0000 Subject: [PATCH] Updated Readme file to include group conventions --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 17cb99f4..a1700adb 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,23 @@ pieces of functionality - we'll refer to them as "plugins". This is a kind of **design by contract**, which you can read about here: . Some things to decide might be: - - Will each piece of functionality be in a separate file or subdirectory? - - Will your team have a naming convention? For example, maybe all - windows enumerators will begin with "wEnum_", linux with "lEnum_" - and so on. + - Will each piece of functionality be in a separate file or subdirectory? TO DO + - Naming Conventions: + lEnum_ + lPrivesc_ + wEnum_ + wPrivesc_ - What will each function return or display? Will each function print out to the user? Or will it return a block of text in a string? Or a list of lines? Or maybe a dict with some meta-info (version, plugin name, plugin author, date, time, etc.) and text data? Or JSON? All are possibilities. + 1.Display to terminal + 2.File - Will you have a standard set of parameters to be passed in? Or can each plugin have a different set of required parameters? + Enumeration- No parameters + Privesc- Specific info for escalation. - What plugins will be implemented? Who will be the author? You should document these decisions here in the `README.md` file. Once