diff --git a/README.md b/README.md index 9d8cb9d..27e3f11 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # moan-ark Todos os identificadores ARK gerados pela Editora Moan + +## O que você vai encontrar aqui? + +Aqui, você encontrará: + +- 2 arquivos (ark_lista.yml e ark_lista.json) contendo uma lista de todos os identificadores ARK gerados pela Editora Moan. Nesses, arquivos há o identificador, o título e o tipo de objeto e um link para o arquivo com os metadados completos; +- Os demais arquivos são os ARK com todos os seus metadados. Cada ARK possui um único arquivo YAML e uma cópia na versão JSON. + +## Sobre os nomes dos arquivos + +Um exemplo de um identificador ARK pode ser "ark:777/a55/d3.By2". Como você pode observar, isso seria problemático para uso em URL e, por isso, uma pequena substituição será feita para nomear os arquivos ARK neste repositório. + +Os ":" (dois pontos) serão substituídos por \_dp\_; o "." (ponto), por \_p\_ e a "/" (barra), por \_b\_. Assim — o arquivo que conteria todos os metadados do hipotético ARK dado como exemplo no parágrafo anterior — seria "ark_dp_777_b_a55_b_d3_p_By2.yml" ou sua cópia em JSON, "ark_dp_777_b_a55_b_d3_p_By2.json". \ No newline at end of file