Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Improve READMEs to keep tracking of whats left
README.md | 27 ++++++++++++++++++++++++++- README.pt-br.md | 27 +++++++++++++++++++++++++++
diff --git a/README.md b/README.md index 98b684bbdebfa48c2116fa0d927f970c22861ea0..d123a3e42780ec167e0f96f22a10ce0cab6beb1e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ # Rascunho -A project to express markdown notes +A project to express markdown notes. + +This project allow you to actually submit a markdown text and it will +give you a simple, no-ads, no tracking, no thrills preview of the text +and a link so you can share with everyone you like. + +All the notes are automatically removed of the database after 7 days. + +We also expose an API so you can create notes from the command line, +just submiting (POSTing) the note to the endpoint `/api/v1`. + +## Things to Work + +- Add the option to give the note a name (optional) +- Save the original blob to the database +- Rig the random url to display the preview of the note +- Handle 500/404 +- API +- Deploy + +## Contributing + +Submit patches, discussions and other stuff to my [public +inbox](mailto:~porcellis/public-inbox@lists.sr.ht). + +Remember to keep a good [mailettiquete](https://people.kernel.org/tglx/notes-about-netiquette-qw89) ## License diff --git a/README.pt-br.md b/README.pt-br.md index 4099492e3d454dd9d33c400b1937b0a44a2d9b27..1781cbb1842c4fbd764b34103a94c2f239ad3079 100644 --- a/README.pt-br.md +++ b/README.pt-br.md @@ -2,6 +2,33 @@ # Rascunho Um projeto para visualizar anotações usando markdown. +Esse projeto permite que você possa submeter um texto no formato +markdown e lhe entregar uma prévia dessa anotação, sem anuncios, sem +rastreamento. Também gera um link para que você possa compartilhar esse +texto por aí. + +Todos os textos são automaticamente deletados depois de 7 dias. + +Também temos uma API para que você possa criar rascunhos, basta fazer +uma requisição POST em `/api/v1`. + +## Coisas para trabalhar ainda + +- Adicionar a opção de poder nomear o rascunho, de forma opcional +- Salvar o texto original no banco +- Quando receber uma url, buscar no banco de dados e gerar um preview +- Lidar com errros 500 (Erro interno) e 404 (Não encontrado) +- API +- Fazer deploy + +## Contribuir + +Mande patches, comece discussões e outras coisas na minha [caixa de +entrada pública](mailto:~porcellis/public-inbox@lists.sr.ht). + +Lembre-se de mandar em texto puro (plain text) e fique atento as [regras +básicas de etiqueta na internet](https://people.kernel.org/tglx/notes-about-netiquette-qw89) + ## Licença Utiliza a Licensa AGPL, veja o arquivo LICENSE para mais informações.