Cria readme do projeto.

Samuel Ramalho
1 parent 409fa565
Showing 1 changed file with 34 additions and 0 deletions Show diff stats
readme.md
@@ -0,0 +1,34 @@
+# ANS Commons SEI
+
+ANS Commons SEI é uma bibliotecaque tem objetivo que prover os objetos utilizados pelos serviços do **SEI-Broker**.
+<br />Esta versão conta com classes de representação de modelo e a classe utilitária SeiHelper.
+
+## Recursos
+
+### SeiHelper
+- A classe utilitária SeiHelper provê métodos para transformação de String e byte[] em Base64 e geração de hash SHA-256.
+
+```java
+// O método calcularHash recebe uma string, calcula e retorna o hash SHA-256 correspondente.
+String sha256 = SeiHelper.calcularHash(string);
+
+// O método getBase64(byte[] bytes) recebe um array de bytes, faz a transformação e retorna o conteúdo Base64 correspondente.
+String base64 = SeiHelper.getBase64(bytes);
+
+// O método getBase64(File arquivo) recebe um objeto File, faz a transformção e retorna o conteúdo Base64 correspondente.
+String base64 = SeiHelper.getBase64(arquivo);
+```
+
+
+
+## Utilização
+
+Com a **biblioteca disponibilizada em seu repositório**, a dependência pode ser referênciada no arquivo pom.xml do projeto como:
+
+```xml
+<dependency>
+    <groupId>br.gov.ans.commons</groupId>
+    <artifactId>ans-commons-sei</artifactId>
+    <version>1.2.1</version>
+</dependency>
+```
 \ No newline at end of file
...	...	@@ -0,0 +1,34 @@
	1	+# ANS Commons SEI
	2	+
	3	+ANS Commons SEI é uma bibliotecaque tem objetivo que prover os objetos utilizados pelos serviços do SEI-Broker.
	4	+<br />Esta versão conta com classes de representação de modelo e a classe utilitária SeiHelper.
	5	+
	6	+## Recursos
	7	+
	8	+### SeiHelper
	9	+- A classe utilitária SeiHelper provê métodos para transformação de String e byte[] em Base64 e geração de hash SHA-256.
	10	+
	11	+```java
	12	+// O método calcularHash recebe uma string, calcula e retorna o hash SHA-256 correspondente.
	13	+String sha256 = SeiHelper.calcularHash(string);
	14	+
	15	+// O método getBase64(byte[] bytes) recebe um array de bytes, faz a transformação e retorna o conteúdo Base64 correspondente.
	16	+String base64 = SeiHelper.getBase64(bytes);
	17	+
	18	+// O método getBase64(File arquivo) recebe um objeto File, faz a transformção e retorna o conteúdo Base64 correspondente.
	19	+String base64 = SeiHelper.getBase64(arquivo);
	20	+```
	21	+
	22	+
	23	+
	24	+## Utilização
	25	+
	26	+Com a biblioteca disponibilizada em seu repositório, a dependência pode ser referênciada no arquivo pom.xml do projeto como:
	27	+
	28	+```xml
	29	+<dependency>
	30	+ <groupId>br.gov.ans.commons</groupId>
	31	+ <artifactId>ans-commons-sei</artifactId>
	32	+ <version>1.2.1</version>
	33	+</dependency>
	34	+```
0	35	\ No newline at end of file
...	...