From: Dariusz Michaluk <d.michaluk@samsung.com>
Date: Wed, 8 Jun 2016 09:58:03 +0000 (+0200)
Subject: Update readme.txt after API changes.
X-Git-Tag: submit/tizen/20160809.225820~59
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d3e4c7fe363f7344c2c9494a23a04880562bc11d;p=platform%2Fcore%2Fsecurity%2Fyaca.git

Update readme.txt after API changes.

Change-Id: Icc18e8370c02e8d9aba507924b4f39bf45dad7f7
---

diff --git a/readme.txt b/readme.txt
index b0fe7f2..664632f 100644
--- a/readme.txt
+++ b/readme.txt
@@ -2,39 +2,35 @@ YACA - Yet Another Crypto API
 
 Basic information:
 
-Code Style (for now):
-	Tabs (8-chars) + spaces;
-	$ astyle -T8 <file>
+Code Style:
+	Tizen coding style (doc/coding-rules.txt)
 
 Project structure:
-	api/ - Public API (headers)
-
-	demos/ - Demo applications
-	doc/ - Documentation
-	examples/ - Usage examples
-
-	src/ - source
-
-	test/ - tests
+	api/yaca/  - Public API (headers)
+	doc/       - Documentation
+	examples/  - Usage examples
+	packaging/ - RPM spec file
+	src/       - Source
 
 General design:
 	- All memory allocated by API should be freed with yaca_free()
-	- Contexts and keys should be freed with yaca_ctx_free()/yaca_key_free()
-	- Function names: yaca_<operation/object>_<function>; Ex: yaca_verify_init()
-	- Simplified/Simple functions don't have <operation/object> part
-	- Enums: YACA_<concept>_<value>; Ex: YACA_KEY_256BIT
+	- Contexts and keys should be freed with yaca_context_destroy()/yaca_key_destroy()
+	- Function names: yaca_<operation/object>_<function>; Ex: yaca_verify_initialize()
+	- Simplified/Simple functions don't have <operation/object> part, but have <simple> prefix
+	- Enums: YACA_<concept>_<value>; Ex: YACA_KEY_LENGTH_256BIT
 	- Objects (context, key) end with _h
-	- Most functions return 0 on success, negative values on error
+	- Functions returns YACA_ERROR_NONE on success, negative values on error
 
 Simplified API:
-	- Is located in simple.h
-	- Currently, to use it - some functions from crypto.h and key.h are needed
-	- Symmetric ciphers (except for GCM) and message digests are only operations that are supported
+	- Is located in yaca_simple.h
+	- Currently, to use it - some functions from yaca_crypto.h and yaca_key.h are needed
+	- Symmetric ciphers (except for GCM and CCM),
+          message digests and signatures are only operations that are supported
 	- All operations are single-shot and output is allocated by library
 
 API:
-	1) All contexts are created by appropriate init() functions
-	2) Keys are created by generate or import functions
+	- All contexts are created by appropriate _initialize() functions
+	- Keys are created by generate or import functions
 
 Examples:
 	- It is possible to compile-check examples with "make" command