Skip to content

Commit

Permalink
Update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
relliv committed Nov 4, 2024
1 parent 171484c commit f42453c
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 82 deletions.
78 changes: 3 additions & 75 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,5 @@
# NxCalendarHeatmap
# nx-calendar-heatmap

<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
[![NX Calendar Heatmap Preview](https://github.com/ngeenx/nx-calendar-heatmap/blob/main/docs/static/img/nx-calendar-heatmap-preview.gif?raw=true)](https://ngeenx.github.io/nx-calendar-heatmap/)

✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.

[Learn more about this workspace setup and its capabilities](https://nx.dev/getting-started/intro#learn-nx?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!

## Finish your CI setup

[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/2MVad3IGAy)


## Run tasks

To run tasks with Nx use:

```sh
npx nx <target> <project-name>
```

For example:

```sh
npx nx build myproject
```

These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.

[More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

## Add new projects

While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.

To install a new plugin you can use the `nx add` command. Here's an example of adding the React plugin:
```sh
npx nx add @nx/react
```

Use the plugin's generator to create new projects. For example, to create a new React app or library:

```sh
# Genenerate an app
npx nx g @nx/react:app demo

# Generate a library
npx nx g @nx/react:lib some-lib
```

You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx list <plugin-name>` to learn about more specific capabilities of a particular plugin. Alternatively, [install Nx Console](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE.

[Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)


[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

## Install Nx Console

Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.

[Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

## Useful links

Learn more:

- [Learn more about this workspace setup](https://nx.dev/getting-started/intro#learn-nx?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects)
- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

And join the Nx community:
- [Discord](https://go.nx.dev/community)
- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
- [Our Youtube channel](https://www.youtube.com/@nxdevtools)
- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
This library is ispried by **[Github](https://github.com/relliv?tab=overview&from=2024-10-01&to=2024-10-27)**'s contribution graph. It is a set of custom heatmap calendar components that can be used to visualize data in a calendar **[heatmap](https://en.wikipedia.org/wiki/Heat_map)** format.
4 changes: 4 additions & 0 deletions docs/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ sidebar_position: 1
# Getting Started

This library is ispried by **[Github](https://github.com/relliv?tab=overview&from=2024-10-01&to=2024-10-27)**'s contribution graph. It is a set of custom heatmap calendar components that can be used to visualize data in a calendar **[heatmap](https://en.wikipedia.org/wiki/Heat_map)** format.

## Preview

<img className="preview-image" src="https://github.com/ngeenx/nx-calendar-heatmap/blob/main/docs/static/img/nx-calendar-heatmap-preview.gif?raw=true" alt="NX Calendar Heatmap"/>
9 changes: 9 additions & 0 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,12 @@
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: #4e5116;
}

.preview-image {
border: 1px solid #dcdcdc;
border-radius: 5px;
minheight: 500px;
width: 100%;
backgroundcolor: #f4f4f48a;
padding: 10px;
}
6 changes: 2 additions & 4 deletions libs/features/nx-angular-calendar-heatmap/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# nx-angular-calendar-heatmap

This library was generated with [Nx](https://nx.dev).
[![NX Calendar Heatmap Preview](https://github.com/ngeenx/nx-calendar-heatmap/blob/main/docs/static/img/nx-calendar-heatmap-preview.gif?raw=true)](https://ngeenx.github.io/nx-calendar-heatmap/)

## Running unit tests

Run `nx test nx-angular-calendar-heatmap` to execute the unit tests.
NX Calendar Heatmap for Angular. Please check the **[documentation](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/angular)** for installation and usage.
4 changes: 3 additions & 1 deletion libs/features/nx-react-calendar-heatmap/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# nx-react-calendar-heatmap

WIP
[![NX Calendar Heatmap Preview](https://github.com/ngeenx/nx-calendar-heatmap/blob/main/docs/static/img/nx-calendar-heatmap-preview.gif?raw=true)](https://ngeenx.github.io/nx-calendar-heatmap/)

NX Calendar Heatmap for React. Please check the **[documentation](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/react)** for installation and usage.
4 changes: 3 additions & 1 deletion libs/features/nx-vue-calendar-heatmap/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# nx-vue-calendar-heatmap

WIP
[![NX Calendar Heatmap Preview](https://github.com/ngeenx/nx-calendar-heatmap/blob/main/docs/static/img/nx-calendar-heatmap-preview.gif?raw=true)](https://ngeenx.github.io/nx-calendar-heatmap/)

NX Calendar Heatmap for Vue. Please check the **[documentation](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/vue)** for installation and usage.
8 changes: 8 additions & 0 deletions libs/utils/nx-calendar-heatmap-utils/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

## [1.0.0] - 2024-11-04

### Added

- Added calendar heatmap utils.
- Added tippy.js tooltip utils.
2 changes: 1 addition & 1 deletion libs/utils/nx-calendar-heatmap-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

[![NX Calendar Heatmap Preview](https://github.com/ngeenx/nx-calendar-heatmap/blob/main/docs/static/img/nx-calendar-heatmap-preview.gif?raw=true)](https://ngeenx.github.io/nx-calendar-heatmap/)

NX Calendar Heatmap utils. Please check the **[documentation](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/angular)** for installation and usage.
NX Calendar Heatmap utils. Please check the **[documentation](https://ngeenx.github.io/nx-calendar-heatmap/)** for installation and usage.

0 comments on commit f42453c

Please sign in to comment.