Skip to content

Commit b72a03f

Browse files
committed
Added node-steam as peer dependency.
Slightly updated the README.
1 parent 9bac58a commit b72a03f

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,14 @@ Example of `groupID64` can be found [here](http://steamcommunity.com/groups/trad
3939

4040
### acknowledgeGroupInvite(steamIdGroup, response)
4141

42-
Accept or decline an invite to join group `steamIdGroup`. `response` is a `boolean` value. This can be used in conjunction with `node-steam`'s `group` event.
42+
Accept or decline an invite to join group `steamIdGroup`. `response` is a `boolean` value.
43+
44+
This can be used in conjunction with `node-steam`'s `group` event.
4345

4446
# Example
4547

4648
```js
47-
// Require node-steam and node-steam-groups first
49+
// Require steam and steam-groups first
4850
var Steam = require('steam');
4951
var SteamGroups = require('steam-groups');
5052

@@ -54,15 +56,16 @@ var steamFriends = new Steam.SteamFriends(client);
5456

5557
var steamGroups = new SteamGroups(client);
5658

57-
// Call logOn and add additional code here ...
59+
// Connect to Steam network and add additional code here ...
5860

59-
// This will work
61+
// Accept any incoming group invite
6062
steamFriends.on('group', function(group, relationship) {
6163
if(relationship === Steam.EClanRelationship.Invited) {
6264
steamGroups.acknowledgeGroupInvite(group, true);
6365
}
6466
});
6567

68+
// Invite anyone who messages us to a group
6669
steamFriends.on('friendMsg', function(user, message, type) {
6770
if(type === Steam.EChatEntryType.ChatMsg) {
6871
steamGroups.inviteUserToGroup('1234567890', user);

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "steam-groups",
33
"version": "1.0.1",
4-
"description": "node-steam extension which adds group functions",
4+
"description": "Custom node-steam handler which provides group functions",
55
"author": "Michael Scholtz <[email protected]>",
66
"license": "MIT",
77
"main": "index.js",
@@ -17,5 +17,8 @@
1717
],
1818
"dependencies": {
1919
"bytebuffer": "*"
20+
},
21+
"peerDependencies": {
22+
"steam": "1.x"
2023
}
2124
}

0 commit comments

Comments
 (0)