📰 update README.md (+ other docs)

Author: lukethacoder

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant 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, caste, color, 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to LWC Dependency Viewer
+
+LWC Dependency Viewer is written in Vanilla TypeScript; and is licensed under the MIT License.
+
+## A few rules
+
+By contributing to LWC Dependency Viewer, you confirm that the work you are submitting is yours and it will be licensed under the MIT License of the project.
+
+To ensure uniformity in LWC Dependency Viewer's repository, every contributor must follow these set of rules:
+
+- Commits must best informative and describe the commit. (e.g. `add x feature to web view`
+- Have ESLint and Prettier installed on your IDE for code formatting.
+- Follow the general Rust conventions
+- Use camelCasing on any function/method/property in code you've contributed.
+
+Please also take a look at the [Code of Conduct](https://github.com/lukethacoder/salesforce-trekken/blob/main/CODE_OF_CONDUCT.md).
+
+## Here’s the process for contributing to LWC Dependency Viewer
+
+- Fork the LWC Dependency Viewer repository, and clone it locally on your development machine.
+- Find help wanted tickets that are up for grabs in GitHub. Comment to let everyone know you’re working on it and let a core contributor assign the issue to you. If there’s no ticket for what you want to work on, you are free to continue with your changes.
+- If in some case you need to use another dependency, create a new issue requesting for the package to be reviewed.
+- After writing your code, make sure it has been formatted with prettier and eslint.
+- When your changes are checked in to your fork, make sure to test your code extensively. Your commits should also follow the commit conventions.
+- Submit your pull request for a code review and wait for a LWC Dependency Viewer core contributor to review it.
+- Last but not least, make sure to have fun with the code!
+
+## Development workspace
+
+### Recommended IDE setup
+
+- IDE: Visual Studio Code (w/ Prettier & ESLint)
+- Node.js (LTS recommended) & NPM
+- pnpm Package Manager
+
+### Building and testing your fork
+
+While testing and making modifications to LWC Dependency Viewer, make sure to familiarise yourself with these three commands.
+
+```bash
+# Install dependencies
+pnpm install
+
+# Run the walk script to generate a new `output.json` file
+pnpm walk
+
+# Start the Vite dev server (opens up in http://localhost:5173)
+pnpm dev
+```

README.md

@@ -1,6 +1,17 @@
-# lwc-dependency-viewer
+<p align="center">
+  <a href="https://ldv.lukesecomb.digital" target="_blank" rel="noopener noreferrer">
+    <img width="180" src="./public/favicon.svg" alt="LWC Dependency Viewer logo">
+  </a>
+</p>
+<h1 align="center">LWC Dependency Viewer</h1>
+<br/>
 
-Scan your LWC files to see the dependencies - displayed on to a cytoscape powered UI
+- 🖼️ Visual representation of your LWCs
+- 🔎 Component Search
+- 💡 Highlight linked components
+- 🔩 Indicators for LWC file types (HTML/JS/CSS)
+- 📦 See which LWC are referencing Apex/StaticResources
+- 🔑 Run locally without needing to install anything into your org
 
 ## Getting Started
 
@@ -9,32 +20,46 @@ pnpm install
 
 # before running, open the `scripts/walk-files.ts` script and replace the 
 # FOLDER_TO_SEARCH` value with your project path.
-# (until we hookup cli args)
+#
+# pending https://github.com/lukethacoder/lwc-dependency-viewer/issues/1
 pnpm walk
 
-
 # run the dev server
 pnpm dev
 
 # this should open at http://localhost:5173/ 
 ```
 
-> output.json here has been generated from the [lightning-base-components](https://www.npmjs.com/package/lightning-base-components) package as an example usage.
+> Default `output.json` has been generated from the [trailheadapps/lwc-recipes](https://github.com/trailheadapps/lwc-recipes) repository as an example usage.
+
+## Screenshots
+
+Hover LWC to see its neighbours
+
+[![](./docs/lwc-dependency-viewer-01.gif)](https://ldv.lukesecomb.digital)
+
+Click an LWC to open up a file view and to see any related Apex Classes and/or StaticResource references
+
+[![](./docs/lwc-dependency-viewer-02.gif)](https://ldv.lukesecomb.digital)
+
+Open up the search (keyboard shortcut `/`) and easily search for the LWC you're looking for.
+
+[![](./docs/lwc-dependency-viewer-03.gif)](https://ldv.lukesecomb.digital)
+
+Hide orphan LWCs that exist on their own and don't relate to other LWCs
+
+[![](./docs/lwc-dependency-viewer-04.gif)](https://ldv.lukesecomb.digital)
+
+
+Adjust the `curve-style` to your liking
+
+[![](./docs/lwc-dependency-viewer-05.gif)](https://ldv.lukesecomb.digital)
+
 
+## Contribution
 
-## TODO:
+See [Contributing Guide](CONTRIBUTING.md).
 
-Functional
-- [ ] setup as cli to run from an `lwc` based project
-- [ ] read module paths from `lwc.config.json`
-- [ ] add Apex Class dependencies
-- [ ] add Static Resource dependencies
+## License
 
-UI
-- [ ] consider bringing in a framework (SolidJS/Astro)
-- [ ] dependency type toggle
-- [ ] hide orphan components
-- [ ] filter by string
-- [ ] style nodes
-- [ ] style edges
-- [ ] option to open in file explorer
+[MIT](LICENSE).