Skip to content

Commit b68fa77

Browse files
committed
docs: added main README.md
1 parent 8769fe0 commit b68fa77

File tree

2 files changed

+61
-9
lines changed

2 files changed

+61
-9
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Stack Overflow for Teams SDK
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)
4+
![Status: Early Access](https://img.shields.io/badge/status-early--access-orange)
5+
6+
> Official TypeScript SDK for interacting with the **Stack Overflow for Teams API**.
7+
8+
The Stack Overflow for Teams SDK lets you build powerful applications and integrations on top of your team’s private knowledge base.
9+
10+
---
11+
12+
## ✨ Features
13+
14+
- 🛠 **Official support** – built and maintained by Stack Overflow with full API coverage.
15+
- 🧑‍💻 **Type safety** – complete TypeScript definitions for all Teams endpoints, models, and responses.
16+
- 📚 **Knowledge access** – query questions, answers, and articles from your team’s private repository.
17+
- 👥 **Team management** – access profiles, activity, and collaborate on internal documentation and Q&A.
18+
19+
⚠️ Currently, this SDK is in **early access** and available only as a **TypeScript library**.
20+
Authentication helpers and rate limiting are not yet included but will be added in future releases.
21+
22+
## 🚀 Installation
23+
24+
Using npm:
25+
26+
```bash
27+
npm install so-teams-sdk
28+
````
29+
30+
Using yarn:
31+
32+
```bash
33+
yarn add so-teams-sdk
34+
```
35+
36+
Using pnpm:
37+
38+
```bash
39+
yarn add so-teams-sdk
40+
```
41+
42+
## 📚 Documentation
43+
44+
* [Quick Start Guide](https://sdk.stackoverflowteams.com/)
45+
* [API v3 Overview](https://stackoverflowteams.help/en/articles/9085836-api-v3-overview)
46+
47+
## 🛠 Contributing
48+
49+
Contributions are welcome! Please open an [issue](https://github.com/StackExchange/StackOverflowSDK/issues) or a [pull request](https://github.com/StackExchange/StackOverflowSDK/pulls).
50+
51+
## 📄 License
52+
53+
This project is licensed under the [MIT License](./LICENSE).

docs/src/content/docs/index.mdx

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ hero:
88
light: ../../assets/stackoverflow-black.svg
99
dark: ../../assets/stackoverflow-white.png
1010
actions:
11-
- text: Quick Start Guide
11+
- text: Get Started
1212
link: ./guides/quickstart/
1313
icon: right-arrow
1414
- text: API Version 3 overview
@@ -28,9 +28,6 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
2828
<Card title="Installation" icon="rocket">
2929
Install the SDK with npm, yarn, or your preferred package manager and start accessing your team's knowledge base immediately.
3030
</Card>
31-
<Card title="Authentication" icon="approve-check">
32-
Set up authentication to securely access your team's private Stack Overflow for Teams instance and data.
33-
</Card>
3431
<Card title="Query Team Knowledge" icon="comment-alt">
3532
Search and retrieve questions, answers, and articles from your team's private knowledge repository.
3633
</Card>
@@ -48,9 +45,6 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
4845
<Card title="Type Safety" icon="laptop">
4946
Complete TypeScript definitions for all Teams endpoints, models, and responses.
5047
</Card>
51-
<Card title="Rate Limiting" icon="seti:clock">
52-
Built-in rate limiting and retry logic to handle API quotas automatically for your team instance.
53-
</Card>
5448
</CardGrid>
5549

5650
## Popular use cases
@@ -65,8 +59,13 @@ Whether you're building internal tools, integrating with existing workflows, or
6559

6660
**Custom Team Apps**: Build specialized interfaces, mobile apps, or integrations tailored to your team's specific needs and workflows.
6761

62+
## Current status
63+
64+
At the moment, the SDK is only available as a **TypeScript library**.
65+
This project is in **early access**, and more language support and features (such as authentication helpers and rate limiting) will be added in the future.
66+
6867
## Ready to start building?
6968

70-
Choose your preferred language and dive into the documentation. Our SDK provides a higher-level abstraction for programmatically interacting with Stack Overflow for Teams, removing friction and enabling you to focus on building great experiences for your team.
69+
Our SDK provides a higher-level abstraction for programmatically interacting with Stack Overflow for Teams, removing friction and enabling you to focus on building great experiences for your team.
7170

72-
The SDK goes beyond just API endpoints - it's designed to provide the ideal developer experience with built-in tools, best practices, and comprehensive guidance for building applications that enhance your team's collaborative knowledge sharing.
71+
The SDK goes beyond just API endpoints - it's designed to provide the ideal developer experience with built-in tools, best practices, and comprehensive guidance for building applications that enhance your team's collaborative knowledge sharing.

0 commit comments

Comments
 (0)