Skip to content

Changed the nominal name #61

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
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
8 changes: 8 additions & 0 deletions @beautiful-tree/algorithms/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Beautiful-Tree Algorithms


[![NPM version (beautiful-tree)](https://img.shields.io/npm/v/@beautiful-tree/algorithms.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/algorithms)
[![TypeScript (beautiful-tree)](https://badgen.net/npm/types/@beautiful-tree/algorithms)](http://www.typescriptlang.org/)
[![License (beautiful-tree)](https://badgen.net/npm/license/@beautiful-tree/algorithms)](https://opensource.org/licenses/MIT)
[![npm downloads (beautiful-tree)](https://img.shields.io/npm/dm/@beautiful-tree/algorithms.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/algorithms)
[![Known Vulnerabilities (beautiful-tree)](https://snyk.io//test/github/Coder-Spirit/nominal/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Coder-Spirit/nominal?targetFile=package.json)
[![Security Score (beautiful-tree)](https://snyk-widget.herokuapp.com/badge/npm/@beautiful-tree%2Falgorithms/badge.svg)](https://snyk.io/advisor/npm-package/@beautiful-tree/algorithms)

## Other members of the family

This is the "core" of the BeautifulTree library. If you are looking for
Expand Down
8 changes: 8 additions & 0 deletions @beautiful-tree/react/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Beautiful-Tree

[![NPM version (beautiful-tree)](https://img.shields.io/npm/v/@beautiful-tree/react.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/react)
[![TypeScript (beautiful-tree)](https://badgen.net/npm/types/@beautiful-tree/react)](http://www.typescriptlang.org/)
[![License (beautiful-tree)](https://badgen.net/npm/license/@beautiful-tree/react)](https://opensource.org/licenses/MIT)
[![npm downloads (beautiful-tree)](https://img.shields.io/npm/dm/@beautiful-tree/react.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/react)
[![Known Vulnerabilities (beautiful-tree)](https://snyk.io//test/github/Coder-Spirit/nominal/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Coder-Spirit/nominal?targetFile=package.json)
[![Security Score (beautiful-tree)](https://snyk-widget.herokuapp.com/badge/npm/@beautiful-tree%2Freact/badge.svg)](https://snyk.io/advisor/npm-package/@beautiful-tree/react)

<p align="center">
<img
src="https://github.com/Coder-Spirit/beautiful-tree/main/docs/example1.svg"
Expand All @@ -15,6 +22,7 @@ Some of its hightlights:
- Very lightweight (3.9Kb in its minimised ESM form, and 4.2Kb in its UMD form)
- The generated trees can be styled with CSS


## Other members of the family

This is the "React variant" of the BeautifulTree library. If you are looking
Expand Down
6 changes: 6 additions & 0 deletions @beautiful-tree/types/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Beautiful-Tree Types

[![NPM version (beautiful-tree)](https://img.shields.io/npm/v/@beautiful-tree/types.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/types)
[![TypeScript (beautiful-tree)](https://badgen.net/npm/types/@beautiful-tree/types)](http://www.typescriptlang.org/)
[![License (beautiful-tree)](https://badgen.net/npm/license/@beautiful-tree/types)](https://opensource.org/licenses/MIT)
[![npm downloads (beautiful-tree)](https://img.shields.io/npm/dm/@beautiful-tree/types.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/types)
[![Known Vulnerabilities (beautiful-tree)](https://snyk.io//test/github/Coder-Spirit/nominal/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Coder-Spirit/nominal?targetFile=package.json)
[![Security Score (beautiful-tree)](https://snyk-widget.herokuapp.com/badge/npm/@beautiful-tree%2Ftypes/badge.svg)](https://snyk.io/advisor/npm-package/@beautiful-tree/types)
## Other members of the family

This is the "types lib" of the BeautifulTree library. If you are looking for
Expand Down
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Some of its hightlights:
- Very lightweight (3.9Kb in its minimised ESM form, and 4.2Kb in its UMD form)
- The generated trees can be styled with CSS

For now there is only a React variant, but we'll extend the support for other
For now there is only a React variant, but we'll extend the support for other
technologies such as Vue.

## Packages in this repository:
Expand All @@ -38,3 +38,33 @@ technologies such as Vue.
- [How to create a React components dual library (ESM+CJS)](https://blog.coderspirit.xyz/blog/2023/09/15/create-a-react-component-lib/):
It covers some of the technical decisions behind this library to offer CJS &
ESM support at the same time.

## Beautiful-Tree Badges

### BeautifulTree Algorithms Lib

[![NPM version (BeautifulTree Algorithms Lib)](https://img.shields.io/npm/v/@beautiful-tree/algorithms.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/algorithms)
[![TypeScript (BeautifulTree Algorithms Lib)](https://badgen.net/npm/types/@beautiful-tree/algorithms)](http://www.typescriptlang.org/)
[![License (BeautifulTree Algorithms Lib)](https://badgen.net/npm/license/@beautiful-tree/algorithms)](https://opensource.org/licenses/MIT)
[![npm downloads (BeautifulTree Algorithms Lib)](https://img.shields.io/npm/dm/@beautiful-tree/algorithms.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/algorithms)
[![Known Vulnerabilities (BeautifulTree Algorithms Lib)](https://snyk.io//test/github/Coder-Spirit/nominal/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Coder-Spirit/nominal?targetFile=package.json)
[![Security Score (BeautifulTree Algorithms Lib)](https://snyk-widget.herokuapp.com/badge/npm/@beautiful-tree%2Falgorithms/badge.svg)](https://snyk.io/advisor/npm-package/@beautiful-tree/algorithms)

### BeautifulTree React Lib

[![NPM version (BeautifulTree React Lib)](https://img.shields.io/npm/v/@beautiful-tree/react.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/react)
[![TypeScript (BeautifulTree React Lib)](https://badgen.net/npm/types/@beautiful-tree/react)](http://www.typescriptlang.org/)
[![License (BeautifulTree React Lib)](https://badgen.net/npm/license/@beautiful-tree/react)](https://opensource.org/licenses/MIT)
[![npm downloads (BeautifulTree React Lib)](https://img.shields.io/npm/dm/@beautiful-tree/react.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/react)
[![Known Vulnerabilities (BeautifulTree React Lib)](https://snyk.io//test/github/Coder-Spirit/nominal/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Coder-Spirit/nominal?targetFile=package.json)
[![Security Score (BeautifulTree React Lib)](https://snyk-widget.herokuapp.com/badge/npm/@beautiful-tree%2Freact/badge.svg)](https://snyk.io/advisor/npm-package/@beautiful-tree/react)

### BeautifulTree Types Lib

[![NPM version (BeautifulTree Types Lib)](https://img.shields.io/npm/v/@beautiful-tree/types.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/types)
[![TypeScript (BeautifulTree Types Lib)](https://badgen.net/npm/types/@beautiful-tree/types)](http://www.typescriptlang.org/)
[![License (BeautifulTree Types Lib)](https://badgen.net/npm/license/@beautiful-tree/types)](https://opensource.org/licenses/MIT)
[![npm downloads (BeautifulTree Types Lib)](https://img.shields.io/npm/dm/@beautiful-tree/types.svg?style=flat)](https://www.npmjs.com/package/@beautiful-tree/types)
[![Known Vulnerabilities (BeautifulTree Types Lib)](https://snyk.io//test/github/Coder-Spirit/nominal/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Coder-Spirit/nominal?targetFile=package.json)
[![Security Score (BeautifulTree Types Lib)](https://snyk-widget.herokuapp.com/badge/npm/@beautiful-tree%2Ftypes/badge.svg)](https://snyk.io/advisor/npm-package/@beautiful-tree/types)