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.

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

chore("branding"): add logo #58

Merged
merged 2 commits into from
Jan 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# We doesn't wan to publish the logo and other
assets
Comment on lines +1 to +2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add the logos inside the .github to avoid being included in the package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that true. But I chose to create a separate dir to allow user to easily found that.

6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<h1 align="center">
🚀 Bench Node
<img
src="https://raw.githubusercontent.com/RafaelGSS/bench-node/refs/heads/main/assets/logo.svg"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use relative path instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No it's unsure to display it correctly on npm without publishing it (logo)

alt="Bench Node logo"
/>
Bench Node
</h1>

<p align="center">
Expand Down
17 changes: 17 additions & 0 deletions assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# "Branding"

## Logo

| Logo | Description |
| --- | --- |
| ![Logo](./logo.svg) | simple logo for readme |
| ![Logo](./logo-text-light.svg) | logo with text for light backgrounds |
| ![Logo](./logo-text-dark.svg) | logo with text for dark backgrounds |

## Other

- **Font**: [Geist](https://fonts.google.com/specimen/Geist)
- **Light Green**: `#84BA64`
- **Dark Green**: `#2C682C`

> The design of the assets was created by [@AugustinMauroy](https://github.com/AugustinMauroy).
14 changes: 14 additions & 0 deletions assets/logo-text-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading