{"id":17228637,"url":"https://github.com/njonsson/example_files","last_synced_at":"2025-03-25T18:44:41.382Z","repository":{"id":66476330,"uuid":"49694113","full_name":"njonsson/example_files","owner":"njonsson","description":"Mix tasks for managing example files in your project","archived":false,"fork":false,"pushed_at":"2017-06-09T04:08:37.000Z","size":46,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-30T16:43:20.864Z","etag":null,"topics":["configuration","developer","elixir","hex-package","mix-tasks"],"latest_commit_sha":null,"homepage":"https://njonsson.github.io/example_files","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/njonsson.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":"License.md","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":"2016-01-15T03:32:51.000Z","updated_at":"2017-11-10T06:33:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"3440aa09-38b5-447e-ba09-665297933aaa","html_url":"https://github.com/njonsson/example_files","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njonsson%2Fexample_files","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njonsson%2Fexample_files/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njonsson%2Fexample_files/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njonsson%2Fexample_files/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/njonsson","download_url":"https://codeload.github.com/njonsson/example_files/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245526071,"owners_count":20629834,"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":["configuration","developer","elixir","hex-package","mix-tasks"],"created_at":"2024-10-15T04:44:39.706Z","updated_at":"2025-03-25T18:44:41.363Z","avatar_url":"https://github.com/njonsson.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# example_files\n\n[\u003cimg alt=\"Travis CI build status\" src=\"https://secure.travis-ci.org/njonsson/example_files.svg?branch=master\" /\u003e][Travis-CI-build-status]\n[\u003cimg alt=\"Hex release\" src=\"https://img.shields.io/hexpm/v/example_files.svg\" /\u003e][Hex-release]\n\n**See what’s changed lately by reading the [project history][project-history].**\n\n## What is an example file?\n\nMany projects contain files which serve as templates or examples for other files.\nThe examples are not themselves operative, but serve to demonstrate the content\nof an operative file, such as developer-specific configuration.\n\nTo illustrate: your project may contain a version-controlled file named\n_config/config.exs.example_. You apply the example configuration by copying\n_config/config.exs.example_ to _config/config.exs_, and in the process you may\ndecide to alter the content, such as tweaking defaults.\n\nThe Mix tasks provided here find, copy, and check the freshness of example files\nand your copies of them.\n\n## Installation\n\nUse *example_files* by adding it to a Mix `deps` declaration.\n\n```elixir\n# mix.exs\n\n# ...\ndefp deps do\n  [{:example_files, \"~\u003e 1.0\", only: [:dev, :test]}]\nend\n# ...\n```\n\n## Usage\n\nThe *example_files* commands are exposed as Mix tasks. Get help on them through\nMix itself, with `mix help | grep example_files` and `mix help example_files`.\n\n* [`mix example_files`][doc-mix-example-files] – lists example files in your\n  project and shows the status of each\n* [`mix example_files.pull`][doc-mix-example-files-pull] — pulls into effect\n  example files in your project by making copies of them using a file name that\n  lacks the “example” nomenclature\n* [`mix example_files.clean`][doc-mix-example-files-clean] — cleans example files\n  in your project by deleting your copies of them\n\n## Contributing\n\nTo submit a patch to the project:\n\n1. [Fork][fork-project] the official repository.\n2. Create your feature branch: `git checkout -b my-new-feature`.\n3. Commit your changes: `git commit -am 'Add some feature'`.\n4. Push to the branch: `git push origin my-new-feature`.\n5. [Create][compare-project-branches] a new pull request.\n\nAfter cloning the repository, `mix deps.get` to install dependencies. Then\n`mix espec` to run the tests. You can also `iex` to get an interactive prompt\nthat will allow you to experiment. To build this package, `mix hex.build`.\n\nTo release a new version:\n\n1. Update [the “Installation” section](#installation) of this readme to reference\n   the new version, and commit.\n2. Update the project history in _History.md_, and commit.\n3. Update the version number in _mix.exs_, and commit.\n4. Tag the commit and push commits and tags.\n5. Build and publish the package on [Hex](Hex-release) with `mix hex.publish`.\n\n## License\n\nReleased under the [MIT License][MIT-License].\n\n[Travis-CI-build-status]:      http://travis-ci.org/njonsson/example_files                        \"Travis CI build status for ‘example_files’\"\n[Hex-release]:                 https://hex.pm/packages/example_files                              \"Hex release of ‘example_files’\"\n[project-history]:             https://github.com/njonsson/example_files/blob/master/History.md   \"‘example_files’ project history\"\n[doc-mix-example-files]:       https://hexdocs.pm/example_files/Mix.Tasks.ExampleFiles.html       \"Documentation on the ‘mix example_files’ task\"\n[doc-mix-example-files-pull]:  https://hexdocs.pm/example_files/Mix.Tasks.ExampleFiles.Pull.html  \"Documentation on the ‘mix example_files.pull’ task\"\n[doc-mix-example-files-clean]: https://hexdocs.pm/example_files/Mix.Tasks.ExampleFiles.Clean.html \"Documentation on the ‘mix example_files.clean’ task\"\n[fork-project]:                https://github.com/njonsson/example_files/fork                     \"Fork the official repository of ‘example_files’\"\n[compare-project-branches]:    https://github.com/njonsson/example_files/compare                  \"Compare branches of ‘example_files’ repositories\"\n[MIT-License]:                 http://github.com/njonsson/example_files/blob/master/License.md    \"MIT License claim for ‘example_files’\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnjonsson%2Fexample_files","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnjonsson%2Fexample_files","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnjonsson%2Fexample_files/lists"}