Skip to content
This repository has been archived by the owner on Jul 20, 2024. It is now read-only.

Commit

Permalink
first init
Browse files Browse the repository at this point in the history
  • Loading branch information
luongngocminh committed Dec 4, 2023
1 parent 1ed9c8a commit cc78a1e
Show file tree
Hide file tree
Showing 66 changed files with 5,984 additions and 349 deletions.
4 changes: 4 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ const options = {
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
],
rules: {
'max-len': ['error', { code: 120 }],
'camelcase': 'error',
},
};

module.exports = options;
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) [year] [authorFullName]
Copyright (c) 2023 Luong Ngoc Minh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# [libraryNameWithSpacesAndUpperCases]
# Atm0s React SDK

[![Continuous Integrations](https://github.com/[repositoryOwner]/[repositoryName]/actions/workflows/continuous-integrations.yaml/badge.svg?branch=main)](https://github.com/[repositoryOwner]/[repositoryName]/actions/workflows/continuous-integrations.yaml)
[![License](https://badgen.net/github/license/[repositoryOwner]/[repositoryName])](./LICENSE)
[![Package tree-shaking](https://badgen.net/bundlephobia/tree-shaking/[libraryName])](https://bundlephobia.com/package/[libraryName])
[![Package minified & gzipped size](https://badgen.net/bundlephobia/minzip/[libraryName])](https://bundlephobia.com/package/[libraryName])
[![Package dependency count](https://badgen.net/bundlephobia/dependency-count/react[libraryName])](https://bundlephobia.com/package/[libraryName])
[![Continuous Integrations](https://github.com/8xff/media-sdk-react/actions/workflows/continuous-integrations.yaml/badge.svg?branch=main)](https://github.com/8xff/media-sdk-react/actions/workflows/continuous-integrations.yaml)
[![License](https://badgen.net/github/license/8xff/media-sdk-react)](./LICENSE)
[![Package tree-shaking](https://badgen.net/bundlephobia/tree-shaking/@8xff/atm0s-media-react)](https://bundlephobia.com/package/@8xff/atm0s-media-react)
[![Package minified & gzipped size](https://badgen.net/bundlephobia/minzip/@8xff/atm0s-media-react)](https://bundlephobia.com/package/@8xff/atm0s-media-react)
[![Package dependency count](https://badgen.net/bundlephobia/dependency-count/react@8xff/atm0s-media-react)](https://bundlephobia.com/package/@8xff/atm0s-media-react)

## Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

```sh
npm install [libraryName] --save
npm install @8xff/atm0s-media-react --save

# For Yarn, use the command below.
yarn add [libraryName]
yarn add @8xff/atm0s-media-react
```

### Installation from CDN
Expand All @@ -23,14 +23,14 @@ This module has an UMD bundle available through JSDelivr and Unpkg CDNs.

```html
<!-- For UNPKG use the code below. -->
<script src="https://unpkg.com/[libraryName]"></script>
<script src="https://unpkg.com/@8xff/atm0s-media-react"></script>

<!-- For JSDelivr use the code below. -->
<script src="https://cdn.jsdelivr.net/npm/[libraryName]"></script>
<script src="https://cdn.jsdelivr.net/npm/@8xff/atm0s-media-react"></script>

<script>
// UMD module is exposed through the "[libraryCamelCaseName]" global variable.
console.log([libraryCamelCaseName]);
// UMD module is exposed through the "Atm0s" global variable.
console.log(Atm0s);
</script>
```

Expand Down
Loading

0 comments on commit cc78a1e

Please sign in to comment.