Skip to content

Commit 66cbf76

Browse files
committed
Added LICENSE and improved the readme to reference oss stream-framework
Fixes #8.
1 parent 316998d commit 66cbf76

File tree

2 files changed

+50
-10
lines changed

2 files changed

+50
-10
lines changed

LICENSE

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) 2014-2017, Stream.io Inc, and individual contributors.
2+
3+
All rights reserved.
4+
5+
Redistribution and use in source and binary forms, with or without modification, are permitted
6+
provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice, this list of
9+
conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice, this list of
12+
conditions and the following disclaimer in the documentation and/or other materials
13+
provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its contributors may
16+
be used to endorse or promote products derived from this software without specific prior
17+
written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
20+
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
21+
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
22+
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27+
POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
## Stream Example App
1+
## Stream Django Example App
22

3-
This example Django app shows you how you can use [GetStream.io](https://getstream.io/ "GetStream.io") to built a site similar to Pinterest.
3+
This example Django app shows you how you can easily build a site similar to Pinterest.
44

5-
### Demo
5+
The project is based on the [stream-django](https://github.com/GetStream/stream-django) integration for [Stream](https://getstream.io/). There is also a lower level [Python - Stream integration](https://github.com/getstream/stream-python) library which is suitable for all Python applications.
66

7-
You can [try the demo here](http://exampledjango.getstream.io).
8-
Alternatively you can deploy your own copy of the demo via Heroku.
7+
You can sign up for a Stream account at https://getstream.io/get_started.
8+
9+
If you're looking to self-host your feed solution we suggest the open source [Stream-Framework](https://github.com/tschellenbach/Stream-Framework), created by the Stream founders.
10+
11+
### Live demo
12+
13+
Try the [live demo](http://exampledjango.getstream.io).
14+
15+
## Deploying the app
916

1017
### Heroku
1118

12-
The best way to try this application is via Heroku; you can deploy this example (for free) on Heroku
13-
by pressing the Deploy button below.
19+
The best way to understand and try out this application is via Heroku. You can deploy the app, for free, simply by clicking the following button:
1420

1521
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
1622

17-
If you prefer to run this locally then make sure to follow the steps in the install file.
23+
### Local
1824

25+
If you prefer to run the project locally, simply follow the steps in the [install.md](install.md) file.
1926

2027
## Tutorial
2128

@@ -38,9 +45,9 @@ We indicate which models should be shared by using the Activity mixin.
3845
class Pin(Activity, models.Model):
3946
...
4047
```
41-
48+
4249
Now when users will add a pin it will automatically show up on the user feed. However to setup the newsfeed we also need
43-
to know who follows who.
50+
to know who follows who.
4451

4552
```
4653
feed_manager.follow_user(user_id, target_id)
@@ -76,3 +83,9 @@ The last bit of work is making sure the templates render nicely.
7683
This will render the templates in
7784

7885
https://github.com/GetStream/Stream-Example-Py/tree/master/templates/activity
86+
87+
## Copyright and License Information
88+
89+
Copyright (c) 2014-2017 Stream.io Inc, and individual contributors. All rights reserved.
90+
91+
See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

0 commit comments

Comments
 (0)