Skip to content

Commit c598cb8

Browse files
committed
chore: Changed README and documentation to indicate the right NPM package
1 parent 2319b9c commit c598cb8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+175
-169
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
run: pnpm install
3232

3333
- name: Build SDK
34-
run: pnpm --filter=so-teams-sdk build
34+
run: pnpm --filter=@stackoverflow/teams-sdk build
3535

3636
- name: Create Release Pull Request or Publish to npm
3737
id: changesets

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ The Stack Overflow for Teams SDK lets you build powerful applications and integr
2323
Using npm:
2424

2525
```bash
26-
npm install so-teams-sdk
26+
npm install @stackoverflow/teams-sdk
2727
````
2828

2929
Using yarn:
3030

3131
```bash
32-
yarn add so-teams-sdk
32+
yarn add @stackoverflow/teams-sdk
3333
```
3434

3535
Using pnpm:
3636

3737
```bash
38-
yarn add so-teams-sdk
38+
yarn add @stackoverflow/teams-sdk
3939
```
4040

4141
## 📚 Documentation

docs/src/content/docs/answers/accept.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Returns a `Promise<AnswerSummaryResponseModel>` containing updated answer summar
2727
### Basic Answer Acceptance
2828

2929
```typescript
30-
import { StackOverflowSDK } from 'so-teams-sdk';
30+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
3131

3232
const sdk = new StackOverflowSDK({
3333
accessToken: 'your-access-token',
@@ -100,7 +100,7 @@ const teamSDK = sdk.forTeam('team-123');
100100
const result = await teamSDK.answers.accept(123, 456);
101101

102102
// Or with direct client initialization
103-
import { AnswerClient } from 'so-teams-sdk';
103+
import { AnswerClient } from '@stackoverflow/teams-sdk';
104104
const teamAnswerClient = new AnswerClient(config, 'team-123');
105105
const acceptResult = await teamAnswerClient.accept(123, 456);
106106
```
@@ -179,7 +179,7 @@ This method can throw the following errors:
179179
### Example Error Handling
180180

181181
```typescript
182-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
182+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
183183

184184
const sdk = new StackOverflowSDK({
185185
accessToken: 'your-access-token',

docs/src/content/docs/answers/create.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Returns a `Promise<AnswerResponseModel>` containing the newly created answer wit
3333
### Basic Answer Creation
3434

3535
```typescript
36-
import { StackOverflowSDK } from 'so-teams-sdk';
36+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
3737

3838
const sdk = new StackOverflowSDK({
3939
accessToken: 'your-access-token',
@@ -91,7 +91,7 @@ const teamAnswer = await teamSDK.answers.create(123, {
9191
});
9292

9393
// Or with direct client initialization
94-
import { AnswerClient } from 'so-teams-sdk';
94+
import { AnswerClient } from '@stackoverflow/teams-sdk';
9595
const teamAnswerClient = new AnswerClient(config, 'team-123');
9696
const answer = await teamAnswerClient.create(123, {
9797
body: 'Team-specific answer content.'
@@ -101,7 +101,7 @@ const answer = await teamAnswerClient.create(123, {
101101
### With Error Handling
102102

103103
```typescript
104-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
104+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
105105

106106
const sdk = new StackOverflowSDK({
107107
accessToken: 'your-access-token',

docs/src/content/docs/answers/delete.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Returns a `Promise<void>`. The method completes successfully if the deletion was
2727
### Basic Answer Deletion
2828
2929
```typescript
30-
import { StackOverflowSDK } from 'so-teams-sdk';
30+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
3131

3232
const sdk = new StackOverflowSDK({
3333
accessToken: 'your-access-token',
@@ -98,7 +98,7 @@ const teamSDK = sdk.forTeam('team-123');
9898
await teamSDK.answers.delete(123, 456);
9999

100100
// Or with direct client initialization
101-
import { AnswerClient } from 'so-teams-sdk';
101+
import { AnswerClient } from '@stackoverflow/teams-sdk';
102102
const teamAnswerClient = new AnswerClient(config, 'team-123');
103103
await teamAnswerClient.delete(123, 456);
104104
```
@@ -118,7 +118,7 @@ This method can throw the following errors:
118118
### Example Error Handling
119119

120120
```typescript
121-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
121+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
122122

123123
const sdk = new StackOverflowSDK({
124124
accessToken: 'your-access-token',

docs/src/content/docs/answers/downvote.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Returns a `Promise<AnswerSummaryResponseModel>` containing updated answer summar
2727
### Basic Downvote
2828

2929
```typescript
30-
import { StackOverflowSDK } from 'so-teams-sdk';
30+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
3131

3232
const sdk = new StackOverflowSDK({
3333
accessToken: 'your-access-token',
@@ -89,7 +89,7 @@ const teamSDK = sdk.forTeam('team-123');
8989
const result = await teamSDK.answers.downvote(123, 456);
9090

9191
// Or with direct client initialization
92-
import { AnswerClient } from 'so-teams-sdk';
92+
import { AnswerClient } from '@stackoverflow/teams-sdk';
9393
const teamAnswerClient = new AnswerClient(config, 'team-123');
9494
const voteResult = await teamAnswerClient.downvote(123, 456);
9595
```
@@ -120,7 +120,7 @@ await changeUpvoteToDownvote(123, 456);
120120
### Handling Vote State Changes
121121

122122
```typescript
123-
import StackOverflowSDK, { ForbiddenError } from 'so-teams-sdk';
123+
import StackOverflowSDK, { ForbiddenError } from '@stackoverflow/teams-sdk';
124124

125125
async function toggleDownvote(questionId: number, answerId: number) {
126126
try {
@@ -160,7 +160,7 @@ This method can throw the following errors:
160160
### Example Error Handling
161161

162162
```typescript
163-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
163+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
164164

165165
const sdk = new StackOverflowSDK({
166166
accessToken: 'your-access-token',

docs/src/content/docs/answers/get.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Returns a `Promise<AnswerResponseModel>` containing the complete answer object w
5353
### Basic Usage
5454

5555
```typescript
56-
import { StackOverflowSDK } from 'so-teams-sdk';
56+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
5757

5858
const sdk = new StackOverflowSDK({
5959
accessToken: 'your-access-token',
@@ -99,7 +99,7 @@ const teamSDK = sdk.forTeam('team-123');
9999
const teamAnswer = await teamSDK.answers.get(123, 456);
100100

101101
// Or with direct client initialization
102-
import { AnswerClient } from 'so-teams-sdk';
102+
import { AnswerClient } from '@stackoverflow/teams-sdk';
103103
const teamAnswerClient = new AnswerClient(config, 'team-123');
104104
const answer = await teamAnswerClient.get(123, 456);
105105
```
@@ -119,7 +119,7 @@ This method can throw the following errors:
119119
### Example Error Handling
120120

121121
```typescript
122-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
122+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
123123

124124
const sdk = new StackOverflowSDK({
125125
accessToken: 'your-access-token',

docs/src/content/docs/answers/getall.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Returns a `Promise<PaginatedAnswers>` containing:
4646
### Basic Usage
4747

4848
```typescript
49-
import { StackOverflowSDK } from 'so-teams-sdk';
49+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
5050

5151
const sdk = new StackOverflowSDK({
5252
accessToken: 'your-access-token',
@@ -112,7 +112,7 @@ This method can throw the following errors:
112112
### Example Error Handling
113113

114114
```typescript
115-
import StackOverflowSDK, { NotFoundError, AuthenticationError } from 'so-teams-sdk';
115+
import StackOverflowSDK, { NotFoundError, AuthenticationError } from '@stackoverflow/teams-sdk';
116116

117117
const sdk = new StackOverflowSDK({
118118
accessToken: 'your-access-token',

docs/src/content/docs/answers/removedownvote.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Returns a `Promise<AnswerSummaryResponseModel>` containing updated answer summar
2727
### Basic Downvote Removal
2828

2929
```typescript
30-
import { StackOverflowSDK } from 'so-teams-sdk';
30+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
3131

3232
const sdk = new StackOverflowSDK({
3333
accessToken: 'your-access-token',
@@ -108,7 +108,7 @@ const teamSDK = sdk.forTeam('team-123');
108108
const result = await teamSDK.answers.removeDownvote(123, 456);
109109

110110
// Or with direct client initialization
111-
import { AnswerClient } from 'so-teams-sdk';
111+
import { AnswerClient } from '@stackoverflow/teams-sdk';
112112
const teamAnswerClient = new AnswerClient(config, 'team-123');
113113
const voteResult = await teamAnswerClient.removeDownvote(123, 456);
114114
```
@@ -160,7 +160,7 @@ This method can throw the following errors:
160160
### Example Error Handling
161161

162162
```typescript
163-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
163+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
164164

165165
const sdk = new StackOverflowSDK({
166166
accessToken: 'your-access-token',

docs/src/content/docs/answers/removeupvote.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Returns a `Promise<AnswerSummaryResponseModel>` containing updated answer summar
2727
### Basic Upvote Removal
2828

2929
```typescript
30-
import { StackOverflowSDK } from 'so-teams-sdk';
30+
import { StackOverflowSDK } from '@stackoverflow/teams-sdk';
3131

3232
const sdk = new StackOverflowSDK({
3333
accessToken: 'your-access-token',
@@ -108,7 +108,7 @@ const teamSDK = sdk.forTeam('team-123');
108108
const result = await teamSDK.answers.removeUpvote(123, 456);
109109

110110
// Or with direct client initialization
111-
import { AnswerClient } from 'so-teams-sdk';
111+
import { AnswerClient } from '@stackoverflow/teams-sdk';
112112
const teamAnswerClient = new AnswerClient(config, 'team-123');
113113
const voteResult = await teamAnswerClient.removeUpvote(123, 456);
114114
```
@@ -160,7 +160,7 @@ This method can throw the following errors:
160160
### Example Error Handling
161161

162162
```typescript
163-
import StackOverflowSDK, { NotFoundError, ForbiddenError } from 'so-teams-sdk';
163+
import StackOverflowSDK, { NotFoundError, ForbiddenError } from '@stackoverflow/teams-sdk';
164164

165165
const sdk = new StackOverflowSDK({
166166
accessToken: 'your-access-token',

0 commit comments

Comments
 (0)