Skip to content
This repository was archived by the owner on Mar 2, 2021. It is now read-only.

Commit 7d5fc23

Browse files
authored
Document removal of /images endpoint
1 parent 6b75bbe commit 7d5fc23

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ For *realtime* database access, you should refer to the [Firebase SDK](https://f
4343
|https://radio4000.firebaseio.com/channels.json|All channels|
4444
|https://radio4000.firebaseio.com/channels/{id}.json|Single channels|
4545
|https://radio4000.firebaseio.com/channelPublics/{id}.json|All channel publics|
46-
|https://radio4000.firebaseio.com/images/{id}.json|All images|
4746
|https://radio4000.firebaseio.com/tracks.json|All tracks from all channels|
4847
|https://radio4000.firebaseio.com/tracks/{id}.json|Single track|
4948

@@ -74,7 +73,6 @@ Listed below are all available models and their properties. Also see this folder
7473
- [userSetting](#usersetting)
7574
- [channel](#channel)
7675
- [channelPublic](#channelpublic)
77-
- [image](#image)
7876
- [track](#track)
7977

8078
### user
@@ -138,16 +136,14 @@ Requires authentication to write.
138136

139137
### Image
140138

141-
For simplicity reasons, and focus of usages, there is only one image
142-
for a radio channel.
143-
139+
For simplicity and focus of usages, a radio can only have one image.
144140
In attent of a better solution, images are hosted at Cloudinary.
145141

146142
``` javascript
147143
let width = 500,
148-
height = 500,
149-
quality = 100,
150-
id = 'drz0qs9lgscyfdztr17t';
144+
height = 500,
145+
quality = 100,
146+
id = 'drz0qs9lgscyfdztr17t';
151147

152148
let base = `https://res.cloudinary.com/radio4000/image/upload/w_${width},h_${height},c_thumb,q_${quality}`;
153149
let image = `${base},fl_awebp/${id}.webp`;
@@ -158,7 +154,6 @@ documentation](https://cloudinary.com/documentation).
158154

159155
You can check how [Radio4000 uses it](https://github.com/internet4000/radio4000/blob/master/app/helpers/cover-img.js).
160156

161-
162157
## Node.js API
163158

164159
In addition to the Firebase API, this repository contains a node.js API in the `src` folder. This is what runs at https://api.radio4000.com. It is configured as a Firebase function. Remember to review the `.firebaserc` and `firebase.json` files.
@@ -211,4 +206,3 @@ Firebase allowed this project to come to life without having the need to spend t
211206
mix radio4000 channels together
212207

213208
Do you want your project to appear here? Send a pull request or get in touch.
214-

0 commit comments

Comments
 (0)