Skip to content

Commit

Permalink
docs: update the teads-curve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
manushak committed Feb 13, 2024
1 parent a64f6e6 commit 25eb59f
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions src/lib/teads-curve/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,22 @@ Resulting values are an estimate based on the testing done by Teads' Engineering
```typescript
import {TeadsCurve, Interpolation} from '@grnsft/if-unofficial-plugins';

const teads = TeadsCurve({
tdp: 100, // TDP of the CPU
interpolation: Interpolation.SPLINE,
});
const results = teads.execute([
const teads = TeadsCurve();
const results = teads.execute(
[
{
duration: 3600, // duration institute
cpu: 100, // CPU usage as a value between 0 to 100 in percentage
datetime: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
},
],
{
duration: 3600, // duration institute
cpu: 100, // CPU usage as a value between 0 to 100 in percentage
datetime: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
},
]);
'teads-curve': {
tdp: 100, // TDP of the CPU
interpolation: Interpolation.SPLINE,
},
}
);
```

## Example `impl`
Expand All @@ -89,7 +94,7 @@ description: simple demo invoking teads-curve
tags:
initialize:
plugins:
- teads-curve
teads-curve:
function: TeadsCurve
path: '@grnsft/if-unofficial-plugins'
graph:
Expand Down

0 comments on commit 25eb59f

Please sign in to comment.