Skip to content

Documentation/readme#53

Merged
gautamkrishnar merged 3 commits intogautamkrishnar:masterfrom
aaxu:documentation/README
May 19, 2017
Merged

Documentation/readme#53
gautamkrishnar merged 3 commits intogautamkrishnar:masterfrom
aaxu:documentation/README

Conversation

@aaxu
Copy link
Contributor

@aaxu aaxu commented May 17, 2017

Hello @gautamkrishnar,

I made a few changes to both README files to make them more clear. I hope you can check whether it still retains the same meanings that were originally there. A few things I did was capitalize "Stack Overflow" and "Python". Other than that, I also bolded the commands in the table to make them more clear. I made the same changes to both files. I assumed that when you said Python 2+, you meant Python 2.0 or higher. Could you possibly mean 2.6 or higher or is 2.0 fine as well?

I also assumed that the README.md file was to be used for GitHub and the README.rst file was for https://pypi.python.org/pypi/socli (Please correct me if I'm wrong). I noticed that there were some new line syntax errors in the Features and To Do section on the website, but I haven't addressed that yet, since I haven't looked up how to edit .rst files correctly yet.

@gautamkrishnar
Copy link
Owner

Looking good... 👍 yes 'readme.rst' is for pypi. I usually generate it automatically from readme.md using a tool named pandoc. Thanks for updating it as well.

Copy link
Owner

@gautamkrishnar gautamkrishnar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@gautamkrishnar gautamkrishnar merged commit 4162833 into gautamkrishnar:master May 19, 2017
@gautamkrishnar
Copy link
Owner

Kudos 🥇 @aaxu

@aaxu aaxu deleted the documentation/README branch May 21, 2017 17:05
gautamkrishnar pushed a commit that referenced this pull request May 22, 2017
…e search, and manual search (#56)

* Fixed some quick spelling mistakes, capitalization, and bolding a title

* Fixed more typoes and reworded some phrases to make it more clear. Also edited and bolded commands in the table to make the examples more clear

* Quick capitalization fix

* Documentation/readme (#53)

* Fixed some quick spelling mistakes, capitalization, and bolding a title

* Fixed more typoes and reworded some phrases to make it more clear. Also edited and bolded commands in the table to make the examples more clear

* Quick capitalization fix

* Reduced chance of crashing when using basic query command which utilizes Google Search

* Implemented Google Search for interactive mode and manual search as well

* Refactored some code to avoid rewriting and tested for correctness

* Quick fix to delete unneeded line
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants