README: add readme

README.md

@@ -1,27 +1,27 @@
-# Static page with nextjs example
+# Noogle
 
-- Generates a static page
-- Includes custom Image loader for static page generation
+Noogle is a Nix API search engine. It allows you to search functions based on their types and other attributes in `nix` projects. In `nixpkgs` especially the `builtins` and `lib` attributes.
 
-## Build
+- Beginners-friendly search for nix and nix-related functions
+- Expert search with directly typing type signatures
+- Search functions based on:
+  - type 
+  - signature
+  - name
+- tree-search from one type to another
  
-> ### ! The build step is completly independent of develop step and can be run right after checkout
+## How it works
+
+The idea is to use a fork of `nixdoc`to generate json data from all functions. That have the `Type` field which is currently supported from nixdoc.
+
+## Contrbute
+
+### Build this page
 
 `nix build .#`
 
-This should create to following result:
-
-- static/
-  - __index.html__
-  - favicon.ico
-  - 404.html
-  - vercel-svg
-  - _next/
-    - static/...
-    - ...
-
-## Develop
+### Develop
 
 `nix develop`
 
-This command creates the node_modules folder with all needed dependencies
+This command creates the node_modules folder with all needed dependencies based on dream2nix.