diff --git a/README.md b/README.md index 187ea77..675e015 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ -# agr_blast_configuration -This repo is used to configure the Alliance Blast Service + +## Description + +This project is a Python application that validates BLAST +database configurations. +It uses JSON configuration files to manage data sources +for nucleotide and protein sequences. + +The docs folder contains documentation on how to create +these configuration files, with required fields and structures. +The files can then be validated using the Python script in this project + +## How to create a JSON configuration file + +[Follow this simple guid on what is required on a +JSON configuration file](docs/README.md) + +### Executing program + +```python +python bin/validate_blast_db_config.py +``` + +## Authors + +Adam Wright and Paulo Nuin with support from the Alliance of Genome Resources +and WormBase + +## Version History + +* 0.1 + * Initial Release