Adds documentation (#1)

.gitignore

@@ -0,0 +1 @@
+.idea

CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+title: 'CrowdStrike Foundry Sample App - Triage with MITRE Attack'
+message: >-
+  If you use this software, and wish to cite the origins, 
+  please use metadata from this file.
+type: software
+authors:
+  - given-names: 
+    family-names: CrowdStrike
+    email: [email protected]
+repository-code: 'https://github.com/CrowdStrike/foundry-sample-mitre'
+url: 'https://www.crowdstrike.com'
+repository-artifact: 'https://pkg.go.dev/github.com/crowdstrike/foundry-sample-mitre'
+abstract: >-
+  The CrowdStrike Foundry Sample App - Triage with
+  MITRE Attack is a community-driven, open source
+  project designed to illustrate creating apps with
+  CrowdStrike Foundry.
+keywords:
+  - crowdstrike
+  - oauth2
+  - crowdstrike-foundry
+  - javascript
+  - windows
+  - linux
+  - mac
+license: MIT

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Community Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected] or https://crowdstrike.ethicspoint.com/.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+
+
+---

README.md

@@ -1,2 +1,8 @@
-# foundry-sample-mitre
-Triage with MITRE Attack sample Foundry app
+![CrowdStrike Falcon](/docs/asset/cs-logo.png?raw=true)
+
+# Triage with MITRE Attack sample Foundry app
+
+The Triage with MITRE Attack sample Foundry app is a community-driven, open source project which serves as an example of an app which can be built using CrowdStrike's Foundry ecosystem.
+`foundry-sample-mitre` is not a formal CrowdStrike project and is maintained by the open source developer community.
+
+TODO !!!

SECURITY.md

@@ -0,0 +1,29 @@
+![CrowdStrike Falcon](/docs/asset/cs-logo.png?raw=true)
+
+# Security Policy
+
+This document outlines security policy and procedures for the CrowdStrike `foundry-sample-mitre` project.
+
+## Reporting a potential security vulnerability
+
+We have multiple avenues to receive security-related vulnerability reports.
+As mentioned in [SUPPORT](https://github.com/CrowdStrike/foundry-sample-mitre/blob/main/SUPPORT.md), this project is generally not a supported CrowdStrike project.
+
+Please report suspected security vulnerabilities by:
+
++ Submitting
+  a [bug](https://github.com/CrowdStrike/foundry-sample-mitre/issues/new?assignees=&labels=bug+%3Abug%3A&template=bug_report.md&title=%5B+BUG+%5D+...).
++ Starting a new [discussion](https://github.com/CrowdStrike/foundry-sample-mitre/discussions).
++ Submitting a [pull request](https://github.com/CrowdStrike/foundry-sample-mitre/pulls) to potentially resolve the issue. (New
+  contributors: please review the content
+  located [here](https://github.com/CrowdStrike/foundry-sample-mitre/blob/main/CONTRIBUTING.md).)
++ Sending an email to __[email protected]__.
+
+## Disclosure and mitigation process
+
+TODO !!!
+
+---
+
+<p align="center"><img src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo-footer.png"><BR/><img width="300px" src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-goblin-panda.png"></P>
+<h3><P align="center">WE STOP BREACHES</P></h3>

SUPPORT.md

@@ -0,0 +1,59 @@
+![CrowdStrike Falcon](/docs/asset/cs-logo.png?raw=true)
+
+# Repository Support
+
+`foundry-sample-mitre` is a community-driven, open source project which serves as an example of an app which can be built using CrowdStrike's Foundry ecosystem.
+`foundry-sample-mitre` is not a formal CrowdStrike project and is maintained by the open source developer community.
+
+## Issue Reporting and Questions 🐛
+
+Issues may be reported [here](https://github.com/CrowdStrike/foundry-sample-mitre/issues/new/choose) and are used to track bugs, documentation and link updates, enhancement requests and security concerns.
+
+### Issue Formatting (MCVE)
+
+Whenever possible, please try to format issues and questions in the [**M**inimal, **C**omplete, and **V**erifiable **E**xample](https://stackoverflow.com/help/minimal-reproducible-example) format. This format reduces "noise", allowing the community to better understand your concern, and provide you with a solution more quickly. This also reduces the likelihood of confidential environment details being accidentally shared within your post.
+
+MCVE formatted code examples provided within issues or questions should be:
+
+- _**Minimal**_: Provide as little as code as possible to produce the problem.
+    - Only provide the [statements required](https://matthewrocklin.com/minimal-bug-reports#see-how-small-you-can-make-things) to create an example of the issue.
+    - Use simple, descriptive names for functions and variables. Don't just copy your existing code.
+    - [Do not include real data](https://matthewrocklin.com/minimal-bug-reports#don-t-post-data). [Mock data examples](https://matthewrocklin.com/minimal-bug-reports#actually-don-t-include-your-data-at-all) to describe the format used, but do not provide real values.
+- _**Complete**_: Provide all the necessary programmatic pieces to recreate the issue.
+    - Do _**not**_ provide screenshots of code.
+    - Use `code blocks` for each file or snippet. Include a description with each block.
+    - Provide all error messages received, including the [complete traceback](https://matthewrocklin.com/minimal-bug-reports#provide-complete-tracebacks).
+- _**Reproducible**_: Provide code that reliably reproduces the problem.
+    - Provide as much detail regarding the problem as possible.
+    - Test your example to make sure it produces consistent results.
+
+> To read more about _MCVE format_, review this post on [Stack Overflow](https://stackoverflow.com/help/minimal-reproducible-example). For tips on how to properly format questions, check out the blog post by [@mrocklin](https://github.com/mrocklin/) on [crafting minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
+
+[![Report Issue](https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/report-issue.png)](https://github.com/CrowdStrike/foundry-sample-mitre/issues/new/choose)
+
+### Support Escalation
+
+In generally, CrowdStrike will support `foundry-sample-mitre` at only the bare minimum level and only in unusual or niche cases.
+CrowdStrike will ultimately defer the support of this project to the open source community.
+
+#### Out of Scope Issues
+
+Depending on the root cause, there is a possibility that an identified issue exceeds the scope of this project, and may require additional investigation. A maintainer may ask you to [contact the CrowdStrike technical support team](https://supportportal.crowdstrike.com/) directly should this occur.
+
+#### Confidentiality
+
+There are also situations where aspects of a support concern cannot be discussed in an online forum, such as:
+
+- customer entitlement
+- data sensitivity
+- environment configuration
+
+_MCVE format_ is designed to reduce the potential for encountering confidentiality concerns while describing your issue, but cannot speak to every scenario. If one of these concerns impacts your ability to post an issue to this repository, please [contact the CrowdStrike technical support team](https://supportportal.crowdstrike.com/) directly making sure to highlight the concern as part of your support request.
+
+
+
+---
+
+
+<p align="center"><img src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo-footer.png"><BR/><img width="300px" src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-bear-1.png"></P>
+<h3><P align="center">WE STOP BREACHES</P></h3>