{"id":18601752,"url":"https://github.com/eficode/beyond-readme","last_synced_at":"2025-05-16T17:33:50.062Z","repository":{"id":152149587,"uuid":"207305785","full_name":"eficode/beyond-readme","owner":"eficode","description":"Demonstrate what to do instead of a long README file","archived":false,"fork":false,"pushed_at":"2019-09-10T08:27:24.000Z","size":189,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-02-18T01:33:32.427Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eficode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-09T12:39:36.000Z","updated_at":"2019-09-10T08:27:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"bbe68981-7eea-40f5-9fc3-85a59f130bff","html_url":"https://github.com/eficode/beyond-readme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eficode%2Fbeyond-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eficode%2Fbeyond-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eficode%2Fbeyond-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eficode%2Fbeyond-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eficode","download_url":"https://codeload.github.com/eficode/beyond-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254576478,"owners_count":22094377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T02:09:18.695Z","updated_at":"2025-05-16T17:33:50.023Z","avatar_url":"https://github.com/eficode.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Beyond README\n\nWelcome to your journey beyond a traditional README file.\n\n---\nThis project contains example operations that you can run:\n* **list_docs:** lists all files in the docs folder \n* **read_file:** reads contents of any file in this repository\n* **foo:** prints bar\n\nA README like this is often out of date, especially if the project contains many complicated operations. In this case, operation _foo_ does not exist. Generally, there are 2 approaches to solve README inconsistency:\n1. Generating a README or docs in general\n2. Making a really short README and executable scripts with autocomplete and help\n\nThese options are not mutually exclusive.\n\nThis example implements executable `operations` with `_autocomplete.sh`.\n\n---\n\n**Note:** this example only works on [zsh](https://ohmyz.sh/) which is the bestest of shells. So if it doesn't work for you please install zsh and become awesome now.\n\n# Running operations\n```\nsource _autocomplete.sh\noperations  # Press tab for autofill (or enter for help)\n```\n![autofill](https://github.com/eficode/beyond-readme/blob/master/docs/autofill.png)\n```\noperations list_docs\n```\n![list_docs](https://github.com/eficode/beyond-readme/blob/master/docs/list_docs.png)\n\n# Tips\n* Your operations should by default expect to be executed from the root of the repo\n* Your CI pipeline should also use the same operations. It ensures that you execute operations in the exactly same way in your CI that you do locally. In addition to that, it makes your CI jobs oneliners which is beautiful and works well also in yaml based pipeline definitions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feficode%2Fbeyond-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feficode%2Fbeyond-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feficode%2Fbeyond-readme/lists"}