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.

Sign up for GitHub

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

improve consistency in the headings & fix typos #30

Merged
merged 1 commit into from
Jul 19, 2022
Merged

improve consistency in the headings & fix typos #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For more information about authentication [go here](#authentication)

## Examples

### Consuming a stream
### Consuming a Stream

```typescript
import { Client } from "twitter-api-sdk";
Expand All @@ -55,7 +55,7 @@ async function main() {
main();
```

### Getting a tweet
### Getting a Tweet

```typescript
import { Client } from "twitter-api-sdk";
Expand Down Expand Up @@ -108,7 +108,7 @@ You can see various examples on how to use the authentication in [examples/](exa

Make sure you turn on OAuth2 in your apps user authentication settings, and set the type of app to be either a confidential client or a public client.

### Creating an public Auth Client
### Creating a Public Auth Client

```typescript
const authClient = new auth.OAuth2User({
Expand All @@ -120,7 +120,7 @@ const authClient = new auth.OAuth2User({
const client = new Client(authClient);
```

### Creating an confidential Auth Client
### Creating a Confidential Auth Client
```typescript
const authClient = new auth.OAuth2User({
client_id: process.env.CLIENT_ID,
Expand All @@ -141,7 +141,7 @@ const authUrl = authClient.generateAuthURL({
});
```

### Getting an Access Token
### Requesting an Access Token

Once the user has approved the OAuth flow, you will receive a `code` query parameter at the callback URL you specified.

Expand All @@ -166,7 +166,7 @@ Note this is only for developers who want to contribute code to the SDK
git clone https://github.com/twitterdev/twitter-api-typescript-sdk
```

### Running the generation script
### Running the Generation Script

Generating the SDK with the [latest OpenAPI spec](https://api.twitter.com/2/openapi.json). The version is any valid [SemVer](https://semver.org/) version

Expand Down