Skip to content

Commit a3d8d9b

Browse files
committed
📓 add lib docs
1 parent 4fa425d commit a3d8d9b

File tree

1 file changed

+5
-54
lines changed

1 file changed

+5
-54
lines changed

README.md

+5-54
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,14 @@
1-
# promo-types, by [Tincre`.dev`](https://tincre.dev/)
1+
# next-gtm-server, by [Tincre](https://tincre.com/)
22

3-
Types for Tincre [Promo](https://tincre.dev/promo). Use it in conjunction with the [`promo-dashboard`](https://github.com/Tincre/promo-dashboard), [`promo-chat`](https://github.com/Tincre/promo-chat), [`promo-button`](https://github.com/Tincre/promo-button) and other Promo integration applications.
3+
This is the GTM portion from the `@next/third-parties`, a collection of components and utilities that can be used to efficiently load third-party libraries into your Next.js applications.
44

5-
- [promo-types, by Tincre`.dev`](#promo-types-by-tincredev)
6-
- [Installation](#installation)
7-
- [Yarn](#yarn)
8-
- [Npm](#npm)
9-
- [Usage](#usage)
10-
- [Support](#support)
11-
- [License](#license)
12-
- [Development](#development)
13-
- [Releases](#releases)
14-
- [Release prep](#release-prep)
15-
- [Test release](#test-release)
16-
- [Release `latest` tag](#release-latest-tag)
5+
> Note: `@next/third-parties` is still experimental and under active development.
176
18-
## Installation
19-
20-
Use your favorite package manager to rock installation of `promo-types`.
21-
22-
### Yarn
23-
24-
```
25-
yarn add @tincre/promo-types# -D if you want this as a dev dep
26-
```
27-
28-
### Npm
29-
30-
```
31-
npm install @tincre/promo-types# --save-dev if you want it as a dev dep
32-
```
33-
34-
### Usage
35-
36-
- Import the types
37-
- Use the types
38-
- Deploy!
39-
40-
#### Usage example
41-
42-
```ts
43-
import { CampaignData } from '@tincre/promo-types';
44-
45-
const data: CampaignData = {
46-
...//your actual stuff here
47-
}
48-
```
49-
50-
## Support
51-
52-
- Documentation: [tincre.dev/docs](https://tincre.dev/docs)
53-
- Guides and how-tos: [tincre.dev/docs/guides](https://tincre.dev/docs/guides)
54-
- Reference docs: [tincre.dev/docs/reference](https://tincre.dev/docs/reference)
55-
- Community: [community.tincre.dev](https://community.tincre.dev)
7+
This version of `GoogleTagManager` allows for custom urls to be set for server-side Google Tag Manager deployments.
568

579
## License
5810

59-
This code is free to use for your commercial or personal projects. It is open-source
60-
licensed under the [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/).
11+
This code is under the MIT license.
6112

6213
You will see various headers throughout the codebase and can reference the license
6314
directly via [LICENSE](/LICENSE) herein.

0 commit comments

Comments
 (0)