diff --git a/README.md b/README.md index edf00cd..fe8b566 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ # YouVersion Core The core of the YouVersion API projects -This project includes the core functions and files that are shared across all the YouVersion applications. \ No newline at end of file +This project includes the core functions and files that are shared across all the YouVersion applications. + +## Directory + +``` +. +├── db +│ ├── books.json # Books and chapters +│ └── versions.json # Bible versions +├── functions # Core functions +├── tests # Automated tests +├── LICENSE +└── README.md +``` + +## Contributing + +Before creating an issue, please ensure that it hasn't already been reported/suggested. + +## License + +This project is licensed under the terms of the +[MIT license](/LICENSE).