Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add supporting websites #95

Merged
merged 2 commits into from
Jun 5, 2023
Merged

docs: add supporting websites #95

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f53bfb8
fixup! feat: embed Overlay as static view in pypi.org (#80)
Jun 5, 2023
f13eb7d
Add resources to the README
Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Overlay aims to help developers make informed decisions when choosing open sourc

### Currently supported

- **Websites:** StackOverflow (see [Issue #14](https://github.com/os-scar/overlay/issues/14) for future plans)
- **Websites:** [StackOverflow](https://stackoverflow.com/questions/29461831), [npmjs.com](https://www.npmjs.com/package/node-sass) and [pypi.org](https://pypi.org/project/requests/) (see [Issue #14](https://github.com/os-scar/overlay/issues/14) for future plans)
- **Registries:** NPM, PYPI and Go (only on `pkg.go.dev`)
- **Advisories:** [Debricked](https://debricked.com/select/), [Snyk](https://snyk.io/advisor/), [Socket](http://socket.dev/) and [DepsDev](https://deps.dev/)

Expand All @@ -53,11 +53,6 @@ https://user-images.githubusercontent.com/1287098/234654340-8300c983-1a01-41fd-8

You can customize the sources that Overlay uses by clicking on the Overlay logo in the extensions bar.

## Technical details

Overlay is written in Vue.js and uses a **background script** to fetch package data from various external sources.
It injects the **indicator** as a _WebComponent_ into the current web pages and uses a **popup menu** to control the displayed sources.

## Feedback

We would love to hear your feedback and suggestions on how to improve Overlay. You can contact us by:
Expand All @@ -74,6 +69,11 @@ Please make sure to follow our code style and conventions.

If you have any questions or suggestions about contributing, please feel free to contact us.

### Technical details

Overlay is written in Vue.js and uses a **background script** to fetch package data from various external sources.
It injects the **indicator** as a _WebComponent_ into the current web pages and uses a **popup menu** to control the displayed sources.

### Local Development

To start developing the extension locally, follow these steps:
Expand All @@ -85,6 +85,10 @@ To start developing the extension locally, follow these steps:

You can now test and debug the extension on _Chrome_ or _Firefox_.

### Resources

- A YouTube video for the [Ma'akaf community](https://discord.gg/fyZ8A5nb) about [how to start to contribute to this project](https://youtu.be/OnxaCXPAWAs) (in Hebrew).

### Contributors

- https://www.linkedin.com/in/baruchiro/
Expand Down