Skip to content

Commit 8849685

Browse files
author
Maya Shavin
committed
chore(docs): update badge and hero image
1 parent 30179c7 commit 8849685

File tree

5 files changed

+46
-5
lines changed

5 files changed

+46
-5
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@
44
55
## `cloudinary-build-url`
66

7+
[![npm version][npm-version-src]][npm-version-href]
8+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
9+
[![Codecov][codecov-src]][codecov-href]
10+
[![License][license-src]][license-href]
11+
712
Build URL for images and videos based on configurations.
813

9-
[📖 Documentation](https://cloudinary-build-url.netlify.app)
14+
[📖 Documentation](https://cloudinary-build-url.netlify.app)
1015

11-
[💻 Code](https://github.com/mayashavin/cloudinary-api/tree/main/packages/url)
16+
[💻 Code](https://github.com/mayashavin/cloudinary-api/tree/main/packages/url)
1217

1318
```
1419
import { buildUrl } from 'cloudinary-build-url'
@@ -29,3 +34,18 @@ const src = buildUrl('example', {
2934
3035
console.log(src)
3136
```
37+
38+
Maintained by [Maya Shavin](https://github.com/mayashavin)
39+
40+
<!-- Badges -->
41+
[npm-version-src]: https://img.shields.io/npm/v/cloudinary-build-url/latest.svg
42+
[npm-version-href]: https://npmjs.com/package/cloudinary-build-url
43+
44+
[npm-downloads-src]: https://img.shields.io/npm/dt/cloudinary-build-url.svg
45+
[npm-downloads-href]: https://npmjs.com/package/cloudinary-build-url
46+
47+
[codecov-src]: https://img.shields.io/codecov/c/github/mayashavin/cloudinary-build-url.svg
48+
[codecov-href]: https://codecov.io/gh/mayashavin/cloudinary-build-url
49+
50+
[license-src]: https://img.shields.io/npm/l/cloudinary-build-url.svg
51+
[license-href]: https://npmjs.com/package/cloudinary-build-url

docs/url-docs/nuxt.config.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,10 @@ import theme from '@nuxt/content-theme-docs'
33
export default theme({
44
docs: {
55
primaryColor: '#3448c5'
6+
},
7+
pwa: {
8+
manifest: {
9+
name: 'Cloudinary URL Builder'
10+
}
611
}
712
})

docs/url-docs/static/preview.png

24.2 KB
Loading

packages/url/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# `cloudinary-build-url`
22

33
[![Netlify Status](https://api.netlify.com/api/v1/badges/c64e43df-e77d-44fb-a0e0-5ca79f8ef188/deploy-status)](https://app.netlify.com/sites/cloudinary-build-url/deploys)
4+
[![npm version][npm-version-src]][npm-version-href]
5+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
6+
[![Codecov][codecov-src]][codecov-href]
7+
[![License][license-src]][license-href]
48

5-
![Cloudinary URL Builder](https://res.cloudinary.com/mayashavin/image/upload/v1605534519/logos/logo-light.png)
9+
![Cloudinary URL Builder](https://res.cloudinary.com/mayashavin/image/upload/v1605534519/logos/logo-light.png)(https://cloudinary-build-url.netlify.app)
610

711
> The lighter URL builder API for Cloudinary with all features in TypeScript.
812
913
By default, `f_auto` (auto format per browser) and `q_auto` (auto quality per device) are enabled. And all the urls are generated as secured HTTPS format, unless user states otherwise.
1014

11-
[📖 Documentation](https://cloudinary-build-url.netlify.app)
15+
[📖&nbsp;Documentation](https://cloudinary-build-url.netlify.app)
1216

1317
## Installation
1418

@@ -90,3 +94,15 @@ const src = buildVideoUrl('dog', {
9094
console.log(src)
9195
```
9296

97+
<!-- Badges -->
98+
[npm-version-src]: https://img.shields.io/npm/v/cloudinary-build-url/latest.svg
99+
[npm-version-href]: https://npmjs.com/package/cloudinary-build-url
100+
101+
[npm-downloads-src]: https://img.shields.io/npm/dt/cloudinary-build-url.svg
102+
[npm-downloads-href]: https://npmjs.com/package/cloudinary-build-url
103+
104+
[codecov-src]: https://img.shields.io/codecov/c/github/mayashavin/cloudinary-build-url.svg
105+
[codecov-href]: https://codecov.io/gh/mayashavin/cloudinary-build-url
106+
107+
[license-src]: https://img.shields.io/npm/l/cloudinary-build-url.svg
108+
[license-href]: https://npmjs.com/package/cloudinary-build-url

packages/url/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cloudinary-build-url",
3-
"version": "0.0.3",
3+
"version": "0.0.4",
44
"description": "Lighter Url generator for Cloudinary",
55
"author": "Maya Shavin <maya@cloudinary.com>",
66
"license": "MIT",

0 commit comments

Comments
 (0)