Comments (12)
Hi @mgenev, I see your point. Theoretically, though, all a user has to do is to go to the Request README because Request-Promise exposes the same API. In any case since you had a bad experience with the docs certainly others do, too.
Since you have fresh eyes: In which section of the README would you expect a link to the Request README? In particular I would link the request options section. If that wouldn't be good enough what would you expect from the docs?
from request-promise.
+1 for info on how to send data in docs. This is simply a one additional line, right?
from request-promise.
Hey guys, I updated the post example in the README. However, since @mgenev found the docs being awful I would appreciate your feedback on how to improve them.
from request-promise.
Haha, I wouldn't say they are awful :)
Thanks!
from request-promise.
;D
from request-promise.
Here's a good example https://visionmedia.github.io/superagent/
I knew how to post right away :D
from request-promise.
One thing I found missing was how to set header variables. I imagine this is a very common requirement and I even suspect there's a very easy way to do it but it was not revealed in the docs. :)
from request-promise.
@ksnyde Thanks for the tip. I will mention that in the next version of the docs. BTW, all docs of Request are valid for Request-Promise, too. So setting headers is the same.
from request-promise.
yeah in the end I did assume that was the case but busy people are stupid people so being explicit pays off more times than not :)
from request-promise.
+1
from request-promise.
I just released 1.0.0 and with that overhauled the README. Thanks for the feedback all you guys! Let me know if can improve something further.
from request-promise.
perfect thanks a lot!
from request-promise.
Related Issues (20)
- Proper way to do retry logic
- How to transform response headers?
- Produces warning for jest 25.5.0
- Uploading file with metadata using unirest js api causing trouble when sending data
- How to curl --http 1.0 in request-promise
- 如何请求图片,返回的数据如何处理呢 HOT 1
- Hey @pradiptabasu , you need to install `request` yourself before you install `request-promise`. See the [installation instructions](https://github.com/request/request-promise#installation).
- error message RequestError: Error: Invalid URI "xxxxxxxx",how to deal it?
- Error: Client network socket disconnected before secure TLS connection was established HOT 3
- Including this library will drag a ton of deps/files... sad
- Error: EPERM: operation not permitted, read
- Terminal
- read timeout
- How to see the request of a failed request ? HOT 3
- WeChat Mini Program can't support 'promise' grammar
- requestpromise
- ignore proxy signed certificate(ssl) issue in request-promise HOT 1
- The "request" library is not installed automatically anymore.
- Request/request-promise
- Issue on a dependency - CVE-2023-26136 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from request-promise.