Skip to content

Commit

Permalink
chore: Update README.md (#1122)
Browse files Browse the repository at this point in the history
* chore: Update README.md

* chore: urls and images

* Update logo size
  • Loading branch information
severinlandolt authored Aug 28, 2024
1 parent 3c67e41 commit a3e7853
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ body:
The issue list is reserved for bug reports and feature requests. If you have a usage question, you can:
- Read the [documentation](https://www.tremor.so/docs/getting-started/installation)
- Read the [documentation](https://npm.tremor.so/docs/getting-started/installation)
- Ask questions on [Slack](https://join.slack.com/t/tremor-community/shared_invite/zt-1u8jqmcmq-Fdr9B6MbnO7u8FkGh~2Ylg)
Also try to search for your issue/feature - another user may have already requested something similar, thanks!
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ body:
The issue list is reserved for bug reports and feature requests. If you have a usage question, you can:
- Read the [documentation](https://www.tremor.so/docs/getting-started/installation)
- Read the [documentation](https://npm.tremor.so/docs/getting-started/installation)
- Ask questions on [Slack](https://join.slack.com/t/tremor-community/shared_invite/zt-1u8jqmcmq-Fdr9B6MbnO7u8FkGh~2Ylg)
Also try to search for your issue/feature - another user may have already requested something similar, thanks!
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Thanks for your interest in contributing to Tremor. Please take a moment to revi
### **Prerequisites**

- You are familiar with [issues](#issues) and [pull requests](#pulls).
- You have read the [docs](https://www.tremor.so/docs/getting-started/installation).
- You have read the [docs](https://npm.tremor.so/docs/getting-started/installation).

### **Issues before PRs**

Expand Down Expand Up @@ -54,8 +54,8 @@ We encourage that you do a self-review prior to requesting a review. To do a sel
### **Documentation**

- We generally encourage you to document your changes through comments in your code.
- If you alter user-facing behavior you must provide documentation for such changes, for reference, check out [our documentation](<[url](https://www.tremor.so/docs/getting-started/introduction)>).
- If you alter user-facing behavior you must provide documentation for such changes, for reference, check out [our documentation](<[url](https://npm.tremor.so/docs/getting-started/introduction)>).

### **Licensing**

By contributing to Tremor, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/tremorlabs/tremor/blob/main/License) license. By submitting your pull request, you agree to our [Contributor License Agreement (CLA)](https://www.tremor.so/contributors). This agreement clarifies our ability to incorporate your contributions.
By contributing to Tremor, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/tremorlabs/tremor/blob/main/License) license. By submitting your pull request, you agree to our [Contributor License Agreement (CLA)](https://tremor.so/contributors). This agreement clarifies our ability to incorporate your contributions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br />
<br />
<p align="center">
<a href="https://tremor.so">
<a href="https://npm.tremor.so">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/tremor-logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/tremor-logo-light.svg">
Expand All @@ -14,10 +14,10 @@
<br />

<div align="center">
<a href="https://www.npmjs.com/package/@tremor/react">
<a href="https://npmjs.com/package/@tremor/react">
<img alt="npm" src="https://img.shields.io/npm/dm/@tremor/react?color=3b82f6&label=npm&logo=npm&labelColor=334155">
</a>
<a href="https://tremor.so/docs/getting-started/introduction">
<a href="https://npm.tremor.so/docs/getting-started/installation">
<img alt="Read the documentation" src="https://img.shields.io/badge/Docs-blue?style=flat&logo=readthedocs&color=3b82f6&labelColor=334155&logoColor=f5f5f5" height="20" width="auto">
</a>
<a href="https://github.com/tremorlabs/tremor/blob/main/License">
Expand All @@ -31,14 +31,14 @@
</a>
</div>
<h3 align="center">
<a href="https://www.tremor.so/docs/getting-started/installation">Documentation</a> &bull;
<a href="https://www.tremor.so">Website</a>
<a href="https://npm.tremor.so/docs/getting-started/installation">Documentation</a> &bull;
<a href="https://npm.tremor.so">Website</a>
</h3>
<br />
<h1>React components to build charts and dashboards</h1>
</div>

[Tremor](https://tremor.so/) 20+ open-source components built on top of Tailwind CSS to make visualizing data simple again. Fully open-source, made by data scientists and software engineers with a sweet spot for design.
[Tremor NPM](https://npm.tremor.so/) 20+ open-source components built on top of Tailwind CSS to make visualizing data simple again. Fully open-source, made by data scientists and software engineers with a sweet spot for design.

<br />

Expand All @@ -48,7 +48,7 @@

## Getting Started

See our [Installation Guide](https://www.tremor.so/docs/getting-started/installation). To make use of the library we also need Tailwind CSS setup in the project.
See our [Installation Guide](https://npm.tremor.so/docs/getting-started/installation). To make use of the library we also need Tailwind CSS setup in the project.

## Example

Expand Down Expand Up @@ -104,7 +104,7 @@ export default function Example() {

## Community and Contribution

We are always looking for new ideas or other ways to improve Tremor. If you have developed anything cool or found a bug, send us a pull request. Check out our Contributor License Agreement [here](https://www.tremor.so/contributors).
We are always looking for new ideas or other ways to improve Tremor NPM. If you have developed anything cool or found a bug, send us a pull request. Check out our Contributor License Agreement [here](https://tremor.so/contributors).

## License

Expand Down
7 changes: 4 additions & 3 deletions images/tremor-logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions images/tremor-logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/stories/vis-elements/BarList.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export const Icon: Story = {

export const Links: Story = {
args: {
data: getData(Array(4).fill({ href: "https://www.tremor.so/" })),
data: getData(Array(4).fill({ href: "https://npm.tremor.so/" })),
valueFormatter: (value) => `${value} USD`,
},
};
Expand All @@ -71,7 +71,7 @@ export const Colors: Story = {
</div>
),
args: {
data: getData(Array(3).fill({ href: "https://www.tremor.so/" })),
data: getData(Array(3).fill({ href: "https://npm.tremor.so/" })),
valueFormatter: (value) => `${value} USD`,
onValueChange: (data) => alert(JSON.stringify(data)),
},
Expand Down

0 comments on commit a3e7853

Please sign in to comment.