Skip to content

Commit 8579e67

Browse files
authored
Merge pull request #45 from GetStream/update-readme
Update README.md
2 parents 21e5ba7 + b85dc5f commit 8579e67

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ const apiKey = 'my-API-key';
4848
const secret = 'my-API-secret';
4949

5050
// Instantiate a new client (server side)
51-
var client = StreamClient.connect(apiKey, secret: secret);
51+
var client = StreamFeedClient.connect(apiKey, secret: secret);
5252

5353
// Optionally supply the app identifier and an options object specifying the data center to use and timeout for requests (15s)
54-
client = StreamClient.connect(apiKey,
54+
client = StreamFeedClient.connect(apiKey,
5555
secret: secret,
5656
appId: 'yourappid',
5757
options: StreamHttpClientOptions(
@@ -68,7 +68,7 @@ final userToken = client.frontendToken('the-user-id');
6868

6969
```dart
7070
// Instantiate new client with a user token
71-
var client = StreamClient.connect(apiKey, token: Token('userToken'));
71+
var client = StreamFeedClient.connect(apiKey, token: Token('userToken'));
7272
```
7373

7474
### 🔮 Examples
@@ -233,7 +233,7 @@ Stream uses [Faye](http://faye.jcoglan.com) for realtime notifications. Below is
233233
```dart
234234
235235
// ⚠️ userToken is generated server-side (see previous section)
236-
final client = StreamClient.connect('YOUR_API_KEY', token: userToken,appId: 'APP_ID');
236+
final client = StreamFeedClient.connect('YOUR_API_KEY', token: userToken,appId: 'APP_ID');
237237
final user1 = client.flatFeed('user', '1');
238238
239239
// subscribe to the changes

packages/stream_feed/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ There is a detailed Flutter example project in the `example` folder. You can dir
3333
First you need to instantiate a feed client. The Feed client will manage API calls. You should only create the client once and re-use it across your application.
3434

3535
```dart
36-
final client = StreamClient.connect("stream-feed-api-key",token:userToken);
36+
final client = StreamFeedClient.connect("stream-feed-api-key",token:userToken);
3737
```
3838
## Contributing
3939

packages/stream_feed/example/main.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Future<void> main() async {
77
final secret = env['secret'];
88
final apiKey = env['apiKey'];
99
final appId = env['appId'];
10-
final clientWithSecret = StreamClient.connect(
10+
final clientWithSecret = StreamFeedClient.connect(
1111
apiKey,
1212
secret: secret,
1313
runner: Runner.server,
@@ -72,7 +72,7 @@ Future<void> main() async {
7272
// response = await userFeed.getActivities(limit: 5, ranking: "popularity");//must be enabled
7373

7474
// Server-side
75-
var client = StreamClient.connect(
75+
var client = StreamFeedClient.connect(
7676
apiKey,
7777
secret: secret,
7878
appId: appId,
@@ -83,7 +83,7 @@ Future<void> main() async {
8383
final userToken = client.frontendToken('user.id');
8484

8585
// Client-side
86-
client = StreamClient.connect(
86+
client = StreamFeedClient.connect(
8787
apiKey,
8888
token: userToken,
8989
appId: appId,
@@ -338,7 +338,7 @@ Future<void> main() async {
338338
object: cheeseBurgerRef,
339339
));
340340

341-
client = StreamClient.connect(apiKey, token: frontendToken);
341+
client = StreamFeedClient.connect(apiKey, token: frontendToken);
342342
// ensure the user data is stored on Stream
343343
await client.setUser({
344344
'name': 'John Doe',

packages/stream_feed/test/stream_feed_client_test.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import 'mock.dart';
88
import 'utils.dart';
99

1010
void main() {
11-
group('StreamClientImpl', () {
11+
group('StreamFeedClientImpl', () {
1212
group('throw', () {
1313
test('throws an AssertionError when no secret or token provided', () {
1414
expect(

0 commit comments

Comments
 (0)