Skip to content

Commit

Permalink
Merge branch 'main' into pr/1065
Browse files Browse the repository at this point in the history
  • Loading branch information
severinlandolt committed Dec 6, 2024
2 parents 9494475 + 94d9f01 commit 2ba9e70
Show file tree
Hide file tree
Showing 46 changed files with 3,859 additions and 6,618 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 .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2.4.2
uses: actions/checkout@v4
- name: node
uses: actions/setup-node@v3.4.1
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
registry-url: https://registry.npmjs.org
- name: install react
run: npm i react
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2.4.2
uses: actions/checkout@v4
- name: node
uses: actions/setup-node@v3.4.1
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
registry-url: https://registry.npmjs.org
- name: install react
run: npm i react
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## **Contributing to Tremor**

Thanks for your interest in contributing to Tremor. Please take a moment to review this document before submitting a pull request. This document will outline how to submit changes to this repository and which conventions to follow. If you are ever in doubt about anything we encourage you to reach out on [Slack](https://join.slack.com/t/tremor-community/shared_invite/zt-1u8jqmcmq-Fdr9B6MbnO7u8FkGh~2Ylg), [open a discussion](#discussions), or [shoot us an email](mailto:[email protected]).
Thanks for your interest in contributing to Tremor. Please take a moment to review this document before submitting a pull request. This document will outline how to submit changes to this repository and which conventions to follow. If you are ever in doubt about anything we encourage you to reach out on [Slack](https://tremor-community.slack.com/join/shared_invite/zt-2a95vjndc-YCKurK3HVAkYtjialnT2_A#/shared-invite/email), [open a discussion](#discussions), or [shoot us an email](mailto:[email protected]).

### **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.
Loading

0 comments on commit 2ba9e70

Please sign in to comment.