work on doc

markdown/bitburner.singularity.joinfaction.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [joinFaction](./bitburner.singularity.joinfaction.md)
+
+## Singularity.joinFaction() method
+
+If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.
+
+This function will automatically accept an invitation from a faction and join it.
+
+<b>Signature:</b>
+
+```typescript
+joinFaction(faction: FactionName): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  faction | [FactionName](./bitburner.factionname.md) | Name of faction to join. |
+
+<b>Returns:</b>
+
+boolean
+
+True if player joined the faction, and false otherwise.
+
+## Remarks
+
+3 GB  Level 2
+