Skip to content

Commit

Permalink
add tips to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
antonizoon committed Nov 25, 2018
1 parent aeb4394 commit c8264fe
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ Documentation is located `here <http://basc-py4chan.readthedocs.org/en/latest/in
Extending this Library
----------------------

There are a wealth of other imageboard APIs that have adopted a similar structure to the 4chan API (such as 8chan/vichan, or 420chan).
There are a wealth of other imageboard APIs that have adopted a similar structure to the 4chan API (such as 8chan/vichan, or 420chan). FoolFuuka also has an API which differs significantly from them since it predates them, but it can be made to fit.

So instead of writing a whole new class from scratch, you could inherit and override BASC-py4chan to support them. Here's how:
So instead of writing a whole new class from scratch, you could inherit and override BASC-py4chan to support them. This would also allow the BASC-Archiver to possibly make it work. Here's how:

.. code:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/changes.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changes from the original py4chan
=================================

Since Edgeworth has gone MIA, `BASC <http://bibanon.org/>`_ has adopted the
Since Edgeworth has gone MIA, `The Bibliotheca Anonoma <http://bibanon.org/>`_ has adopted the
project and made the following improvements.

Changes by `antonizoon <https://github.com/antonizoon>`_
Expand Down
12 changes: 6 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@

# General information about the project.
project = u'BASC-py4chan'
copyright = u'2014, Antonizoon (Lawrence Wu)'
copyright = u'2014, Antonizoon Overtwater'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.4.2'
version = '0.6.3'
# The full version, including alpha/beta/rc tags.
release = '0.4.2'
release = '0.6.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -194,7 +194,7 @@
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'BASC-py4chan.tex', u'BASC-py4chan Documentation',
u'Antonizoon (Lawrence Wu)', 'manual'),
u'Antonizoon Overtwater', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -224,7 +224,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'basc-py4chan', u'BASC-py4chan Documentation',
[u'Antonizoon (Lawrence Wu)'], 1)
[u'Antonizoon Overtwater'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -238,7 +238,7 @@
# dir menu entry, description, category)
texinfo_documents = [
('index', 'BASC-py4chan', u'BASC-py4chan Documentation',
u'Antonizoon (Lawrence Wu)', 'BASC-py4chan', 'One line description of project.',
u'Antonizoon Overtwater', 'BASC-py4chan', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
"original py-4chan wrapper."),
long_description=open('README.rst').read(),
license=open('LICENSE').read(),
author='Antonizoon (Lawrence Wu)',
author_email='[email protected]',
author='Antonizoon Overtwater',
author_email='[email protected]',
url='http://github.com/bibanon/BASC-py4chan',
packages=['basc_py4chan'],
package_dir={
Expand Down

0 comments on commit c8264fe

Please sign in to comment.