Skip to content

Commit 3fe546d

Browse files
heatonjbheatonjb
committed
README update with CLA and new License and version 1 bump
1 parent b6f0fed commit 3fe546d

3 files changed

Lines changed: 100 additions & 4 deletions

File tree

‎LICENSE.md‎

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

‎README.md‎

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,19 @@ Requires
1212
* simplejson
1313

1414

15-
Discussion
16-
------
15+
Instagram REST and Search APIs
16+
------------------------------
17+
Our [developer site](http://instagram.com/developer) documents all the Instagram REST and Search APIs.
18+
19+
20+
Blog
21+
----------------------------
22+
The [Developer Blog] features news and important announcements about the Instagram Platform. You will also find tutorials and best practices to help you build great platform integrations. Make sure to subscribe to the RSS feed not to miss out on new posts: [http://developers.instagram.com](http://developers.instagram.com).
1723

18-
Visit [our Google Group](http://groups.google.com/group/instagram-api-developers) to discuss the Instagram API.
24+
25+
Community
26+
----------------------
27+
The [Stack Overflow community](http://stackoverflow.com/questions/tagged/instagram/) is a great place to ask API related questions or if you need help with your code. Make sure to tag your questions with the Instagram tag to get fast answers from other fellow developers and members of the Instagram team.
1928

2029

2130
Authentication
@@ -167,3 +176,60 @@ authentication, subscriptions, and update processing. To try it out:
167176
* Open up sample\_app.py, update it with your client\_id and secret, and set redirect URI to 'http://localhost:8515/oauth_callback'
168177
* Run the file; it will host a local server on port 8515.
169178
* Try visiting http://localhost:8515 in your browser
179+
180+
Contributing
181+
------------
182+
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
183+
184+
Here are some ways *you* can contribute:
185+
186+
* by using alpha, beta, and prerelease versions
187+
* by reporting bugs
188+
* by suggesting new features
189+
* by writing or editing documentation
190+
* by writing specifications
191+
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
192+
* by refactoring code
193+
* by closing [issues](http://github.com/Instagram/python-instagram/issues)
194+
* by reviewing patches
195+
196+
197+
Submitting an Issue
198+
-------------------
199+
We use the [GitHub issue tracker](https://github.com/Instagram/python-instagram/issues) to track bugs and
200+
features. Before submitting a bug report or feature request, check to make sure it hasn't already
201+
been submitted. You can indicate support for an existing issue by voting it up. When submitting a
202+
bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
203+
details that may be necessary to reproduce the bug, including your version number, and
204+
operating system. Ideally, a bug report should include a pull request with failing specs.
205+
206+
Instagram has a [bounty program](https://www.facebook.com/whitehat/) for the safe
207+
disclosure of security bugs. In those cases, please go through the process
208+
outlined on that page and do not file a public issue.
209+
210+
211+
Submitting a Pull Request
212+
-------------------------
213+
1. Fork the project.
214+
2. Create a topic branch.
215+
3. Implement your feature or bug fix.
216+
4. Run <tt>python tests.py </tt>.
217+
5. Add a test for your feature or bug fix.
218+
6. Run <tt>python tests.py </tt>. If your changes are not 100% covered, go back to step 5.
219+
7. Commit and push your changes.
220+
8. Submit a pull request.
221+
9. If you haven't already, complete the Contributor License Agreement ("CLA").
222+
223+
Contributor License Agreement ("CLA")
224+
_____________________________________
225+
In order to accept your pull request, we need you to submit a CLA. You only need
226+
to do this once to work on any of Instagram's or Facebook's open source projects.
227+
228+
Complete your CLA here: [https://code.facebook.com/cla](https://code.facebook.com/cla)
229+
230+
231+
Copyright
232+
---------
233+
Copyright (c) 2014, Facebook, Inc. All rights reserved.
234+
By contributing to python-instagram, you agree that your contributions will be licensed under its BSD license.
235+
See [LICENSE](https://github.com/Instagram/python-instagram/blob/master/LICENSE.md) for details.

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from setuptools import setup, find_packages
33

44
setup(name="python-instagram",
5-
version="0.8.0",
5+
version="1.0.0",
66
description="Instagram API client",
77
license="MIT",
88
install_requires=["simplejson","httplib2"],

0 commit comments

Comments
 (0)