Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the README #723

Closed
7 of 9 tasks
noviluni opened this issue Jun 25, 2020 · 3 comments
Closed
7 of 9 tasks

Improve the README #723

noviluni opened this issue Jun 25, 2020 · 3 comments

Comments

@noviluni
Copy link
Collaborator

noviluni commented Jun 25, 2020

This library doesn't have a website (apart from the docs), so the README should be treated as a presentation of the library.

I think we could add a fresher vision over this library and focus it over the use cases instead of including parts from the docs.

  • Add new logo (blocked by add artwork #719)
  • Installation
  • Supported Python versions
  • Basic examples (current content with some simplifications) with basic settings.
  • Common use cases (more on this below)
  • Multiple links to docs (how to contribute, etc).
  • Recommendation: to use languages or locales when knowing the language to improve performance and unexpected behaviors.
  • Explaining that what you have to pass to the parse() method is a date string, not a string containing a date.
  • Explain that search_dates is not fully supported and it has a lot of limitations.

If you have any idea don't hesitate to add a comment!


Ideas of use cases

When to use dateparser?

When consuming data from different sources:

  • Scraping: extract dates from different places with several different formats and languages
  • IoT: consuming data coming from different sources with different date formats
  • Tooling: consuming dates from different logs / sources
  • Format transformations: when transforming dates coming from files (PDF, CSV, etc.) to other formats (database, etc).

When offering natural interaction with users

  • Tooling and CLI: allow users to write “3 days ago” to retrieve information.
  • Search engine: allow people to search by date in an easiest / natural format.
  • Bots: allow users to interact with a bot easily
@noviluni
Copy link
Collaborator Author

noviluni commented Sep 8, 2020

I started working on this.

My idea is to create a new README.md file (which is better supported by Github) and move the current content or part of the content to the docs. You can see a preview of the version I'm working here: https://github.com/noviluni/dateparser/tree/improve_readme

@Gallaecio any feedback will be welcomed :)

@noviluni
Copy link
Collaborator Author

noviluni commented Sep 8, 2020

Added new PR! #779

@noviluni
Copy link
Collaborator Author

As the PR #779 has been merged I will close this issue.

The missing sections will be omitted from the README as they are in the docs (and the search_dates has its own ticket: #737).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants