diff --git a/README.md b/README.md index 93eb55d..0f9d4ae 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,48 @@ -# TSDX User Guide +# link-previewer -Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it. +[![npm version](https://img.shields.io/github/package-json/v/nzambello/link-previewer)](https://www.npmjs.com/package/link-previewer) +![Tests](https://github.com/nzambello/link-previewer/workflows/CI/badge.svg?branch=main) +![TypeScript Support](https://img.shields.io/badge/TypeScript-Support-blue) -> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`. +Node util to retrieve preview info from a link (og tags, meta tags, images, videos). -> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript) +## Installation -## Commands +```bash +yarn add link-previewer +``` -TSDX scaffolds your new library inside `/src`. +```bash +npm install link-previewer +``` + +## Usage + +```ts +import getLinkPreview from 'link-previewer'; + +getLinkPreview('https://www.youtube.com/watch?v=feH26j3rBz8').then(console.log); +``` + +### Result + +```json +{ + "description": "How much do we know about the impact of technologies we use everyday? How much the web industry is responsible for carbon emissions? Can we define an ethic d...", + "favicon": "https://www.youtube.com/s/desktop/ce262d3b/img/favicon.ico", + "image": "https://i.ytimg.com/vi/feH26j3rBz8/maxresdefault.jpg", + "imageHeight": 720, + "imageWidth": 1280, + "images": [], + "mediaType": "video.other", + "siteName": "YouTube", + "title": "A sustainable web: is it possible? - Nicola Zambello", + "video": "https://www.youtube.com/embed/feH26j3rBz8", + "videos": [] +} +``` + +## Development To run TSDX, use: @@ -22,9 +56,9 @@ To do a one-off build, use `npm run build` or `yarn build`. To run tests, use `npm test` or `yarn test`. -## Configuration +### Formatting and linting -Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. +Code quality is set up with `prettier`, `husky`, and `lint-staged`. ### Jest @@ -34,21 +68,6 @@ Jest tests are set up to run with `npm test` or `yarn test`. [`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`. -#### Setup Files - -This is the folder structure we set up for you: - -```txt -/src - index.tsx # EDIT THIS -/test - blah.test.tsx # EDIT THIS -.gitignore -package.json -README.md # EDIT THIS -tsconfig.json -``` - ### Rollup TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. @@ -57,16 +76,16 @@ TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rol `tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs. -## Continuous Integration +### Continuous Integration -### GitHub Actions +#### GitHub Actions Two actions are added by default: - `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix - `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit) -## Optimizations +### Optimizations Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations: @@ -82,22 +101,16 @@ if (__DEV__) { You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions. -## Module Formats +### Module Formats CJS, ESModules, and UMD module formats are supported. The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found. -## Named Exports +### Commitlint -Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library. +We use [commmitlint](https://commitlint.js.org/) for commit message validation based on [Conventional Commits](https://www.conventionalcommits.org/en/). -## Including Styles +### Release -There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like. - -For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader. - -## Publishing to NPM - -We recommend using [np](https://github.com/sindresorhus/np). +Changelog and release management with [release-it](https://github.com/release-it/release-it), using [convential changelog](https://github.com/release-it/conventional-changelog).