svn commit: r239444 - /incubator/tsik/trunk/README.txt

[ha...@apache.org]

Author: hans
Date: Tue Aug 23 11:55:36 2005
New Revision: 239444

URL: http://svn.apache.org/viewcvs?rev=239444&view=rev
Log:
updated README info

Modified:
    incubator/tsik/trunk/README.txt

Modified: incubator/tsik/trunk/README.txt
URL: http://svn.apache.org/viewcvs/incubator/tsik/trunk/README.txt?rev=239444&r1=239443&r2=239444&view=diff
==============================================================================
--- incubator/tsik/trunk/README.txt (original)
+++ incubator/tsik/trunk/README.txt Tue Aug 23 11:55:36 2005
@@ -1,3 +1,93 @@
+$Id$
+
 IMPORTANT INFORMATION REGARDING IP RIGHTS AND AUTHORIZATIONS 
 IS CONTAINED IN THE NOTICE.TXT FILE THAT END USERS MUST READ 
 PRIOR TO USE.
+
+
+
+
+Welcome to TSIK
+---------------
+
+Apache TSIK is an XML/SOAP security library/toolkit that implements 
+several of the WS-* standards as defined by both OASIS and W3C. Please 
+see the javadocs API for more information.
+
+Apache TSIK is currently in incubation with the Apache Software
+Foundation. More information can be found on
+
+   http://incubator.apache.org/tsik/
+
+On the same page is a link to the roadmap, which describes thoughts
+on future TSIK development.
+
+   http://incubator.apache.org/tsik/roadmap.html
+
+
+Philosophy
+----------
+
+* Simplicity
+
+Apache TSIK is developed with simplicity of use in mind. Originally
+developed by VeriSign, TSIK is based on a philosophy that 
+most application security errors occur when existing APIs are so
+complex that it becomes easy to use them incorrectly. TSIK 
+therefore strives for simple APIs that cover main use cases. 
+
+* Few dependencies
+
+Apache TSIK has very few dependencies on other projects. It used
+the log4j logging sub system and that is it. 
+
+TSIK compiles out of the box with JDK 1.3 and higher into a single 
+jar, tsik.jar. The log4j jar file is included in the source 
+distribution. 
+
+Apache TSIK comes with its own set of XML/SOAP utility classes to
+create and parse XML.
+
+* Interop driven
+
+Apache TSIK will be developed primarily by interop. If a toolkit 
+manages to interoperate via everyday scenarios (such are typically
+the scenarios at interop events), then it is a useful toolkit. 
+
+Usability
+---------
+
+Before landing at Apache, TSIK had been in development for over four 
+years, oftem by the same people who co-authored many of the underlying
+specifications. TSIK is today used in several commercial products and 
+considered quite stable.
+
+
+Installation
+------------
+
+* Get the source
+  Probably done since you're reading this :)
+
+* Set up ant. 
+  Make sure you can run JUnit tasks. This should be fairly straight-
+  forward. (You can use the junit.jar in ./resources if you don't have 
+  junit set up.)
+
+* Set up your Java JCE provider. 
+  If you don't have a JCE provider that provides RSA encryption and
+  signing, you need to install one. See e.g., http://www.bouncycastle.org/
+
+* Build the library, test it, and generate javadoc APIs with 
+
+  $ ant build test api
+
+* That's it.
+
+
+Installation (binary distribution)
+----------------------------------
+
+There is no binary distribution since Apache TSIK is still in incubation.
+
+



---------------------------------------------------------------------
To unsubscribe, e-mail: tsik-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: tsik-dev-help@ws.apache.org