Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Usage" to the README #8

Open
cowchimp opened this issue Apr 25, 2017 · 3 comments
Open

Add "Usage" to the README #8

cowchimp opened this issue Apr 25, 2017 · 3 comments

Comments

@cowchimp
Copy link

cowchimp commented Apr 25, 2017

Hi.

I think the README could benefit from a short "Usage" section below the "Installation" section.
It should show what you should actually require() in your code - require('request') OR require('request-promise-native').

Thanks.

@nwhitmont
Copy link

@analog-nico any update on adding basic usage examples?

@hackhat
Copy link

hackhat commented Jun 28, 2018

After a while figuring out this lib I can use this. Pretty bad docs.

    import * as request from 'request-promise-native'; // typescript import
    try {
      const res = await request
        .post('http://localhost:1001/register')
        .form({
          name: this.state.name,
          email: this.state.email,
          password: this.state.password,
        })
    } catch (e) {
      console.error(e);
    }

@nwhitmont
Copy link

this repo does not appear to be actively maintained. :-(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants