Forráskód Böngészése

Make it more useable.

Cixo Develop 6 hónapja
szülő
commit
df9fff711e
1 módosított fájl, 32 hozzáadás és 2 törlés
  1. 32 2
      README.md

+ 32 - 2
README.md

@@ -1,3 +1,33 @@
-# cx-apikey
+## cx-apikey is easy to use and small API keys system.
+It could be used to generating API keys, validating them and also works with
+them in the system. API keys generator use operating system random number 
+generator, tokens have also selected prefixes, size of them could be changed,
+default its 256 letters.
 
-That is simple apikey generator, which could be used in web projects.
+### How simple is it?
+First, install it from PyPi.
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install cx-apikey
+```
+
+Then, You can use it in app. Let's generate first API key.
+
+```python
+import cx_apikey as apikey
+
+test = apikey.apikey_factory("test").set_size(128).generate()
+print(repr(test))
+```
+
+You would see something like that:
+
+```bash
+API key: "test_1bf6b4320bc893435934ebe634f447f4e2d5076edda950357b95f2
+01e98640268cb1d23e571d3a6f9883300eac0605d553dfa662920390a322023441c05"
+```
+
+### For more complex usage see project wiki
+[All pages](https://git.cixoelectronic.pl/cixo-electronic/cx-apikey/wiki/_pages)