search

jambonz / create-jambonz-app

Scaffold a jambonz webhook application using the Node.js SDK
2 stars 2 forks source link

README.md in created app slightly out of date #4

Open ghenry opened 2 years ago

ghenry commented 2 years ago

Hi all,

I note in https://github.com/jambonz/create-jambonz-app/tree/main/templates/lib/routes/endpoints that there are more endpoints than listed at https://www.jambonz.org/docs/client-sdks/create-jambonz-app/ and the version installed by npx is behind, as I only see these in my demo app:

ls -1 lib/routes/endpoints/
call-status.js
dial-time.js
index.js
tts-hello-world.js

Are the docs for the .org website on GitHub for PR? Is the best way to run from this repo for example app creation? Looks like it :-)

Anyway, thanks for the hard work and great examples!

Gavin.

ghenry commented 2 years ago

Nevermind. Read the docs properly. No issue.

ghenry commented 2 years ago

Actually, it's just the README.md that gets created that is slightly out of date. It only lists:

# my-app

This application was created with the [create jambonz command](https://www.npmjs.com/package/create-jambonz-app).  This documentation was generated at the time when the project was generated and describes the functionality that was initially scaffolded.  Of course, you should feel free to modify or replace this documentation as you build out your own logic.

## Endpoints

Based on the options that you have chosen, this application exposes the following HTTP endpoints:

### /dial-time
Dials out through your carrier to a US-based [speaking time clock service](https://www.nist.gov/time-distribution/radio-station-wwv/telephone-time-day-service).

### /hello-world
Answers incoming call and plays a greeting using text-speech

which is missing the call-status endpoint.

Thanks.

ghenry commented 2 years ago

But this looks good - https://github.com/jambonz/create-jambonz-app/blob/main/templates/README.md

ghenry commented 2 years ago

Yeah, just /call-status missing from the template.